public inbox for gcc-cvs@sourceware.org
help / color / mirror / Atom feed
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-07 13:00 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-07 13:00 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:f609b12791d3a6555d1d7b33e9cf07df5a9fa938
commit f609b12791d3a6555d1d7b33e9cf07df5a9fa938
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 14:42 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 14:42 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:3f0b031bf0ee27554462bc1d4a13e337cafb27f6
commit 3f0b031bf0ee27554462bc1d4a13e337cafb27f6
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 14:35 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 14:35 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:d03ab4ee24188e8578cf28d096733a9e20da4f8c
commit d03ab4ee24188e8578cf28d096733a9e20da4f8c
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 14:34 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 14:34 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:7e82d8336e72f767565893e299d73622b5c03b63
commit 7e82d8336e72f767565893e299d73622b5c03b63
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 12:06 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 12:06 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:cb6ea88185eb7f81083bfe7a9e780cf2f2f60c6e
commit cb6ea88185eb7f81083bfe7a9e780cf2f2f60c6e
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 11:38 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 11:38 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:a1e0c08b6b11f5584dee10357d0f19a859416bf5
commit a1e0c08b6b11f5584dee10357d0f19a859416bf5
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-08 10:20 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-08 10:20 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:34fe6bb10bc40141d07999e7ab913d1952034e9a
commit 34fe6bb10bc40141d07999e7ab913d1952034e9a
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-07 14:33 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-07 14:33 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:dd3054f3a158eab988391d6cb8a7af05528d2065
commit dd3054f3a158eab988391d6cb8a7af05528d2065
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-07 14:19 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-07 14:19 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:fe3a2931fcfc9633e20676ba0b706f98e19269a9
commit fe3a2931fcfc9633e20676ba0b706f98e19269a9
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-07 14:06 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-07 14:06 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:fa7d3abb3de841c02bfe7358181831216fa9bd34
commit fa7d3abb3de841c02bfe7358181831216fa9bd34
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
* [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST
@ 2022-11-07 12:37 Martin Liska
0 siblings, 0 replies; 11+ messages in thread
From: Martin Liska @ 2022-11-07 12:37 UTC (permalink / raw)
To: gcc-cvs
https://gcc.gnu.org/g:be2d6ba97b894d0f3b1c16e84dd4bf69a81f60dd
commit be2d6ba97b894d0f3b1c16e84dd4bf69a81f60dd
Author: Martin Liska <mliska@suse.cz>
Date: Mon Nov 7 13:12:33 2022 +0100
sphinx: port .def files to RST
gcc/c-family/ChangeLog:
* c-target.def: Port to RST.
gcc/ChangeLog:
* common/common-target.def: Port to RST.
* target.def: Port to RST.
gcc/d/ChangeLog:
* d-target.def: Port to RST.
Diff:
---
gcc/c-family/c-target.def | 24 +-
gcc/common/common-target.def | 28 +-
gcc/d/d-target.def | 36 +-
gcc/target.def | 3305 +++++++++++++++++++++---------------------
4 files changed, 1701 insertions(+), 1692 deletions(-)
diff --git a/gcc/c-family/c-target.def b/gcc/c-family/c-target.def
index 141dcf30716..aebfbecd9cb 100644
--- a/gcc/c-family/c-target.def
+++ b/gcc/c-family/c-target.def
@@ -48,26 +48,26 @@ and between C, C++ and their respective Objective-C dialects.\n\
A string object might, for example, embed encoding and length information.\n\
These objects are considered opaque to the compiler and handled as references.\n\
An ideal implementation makes the composition of the string object\n\
-match that of the Objective-C @code{NSString} (@code{NXString} for GNUStep),\n\
+match that of the Objective-C ``NSString`` (``NXString`` for GNUStep),\n\
allowing efficient interworking between C-only and Objective-C code.\n\
If a target implements string objects then this hook should return a\n\
-reference to such an object constructed from the normal `C' string\n\
-representation provided in @var{string}.\n\
+reference to such an object constructed from the normal 'C' string\n\
+representation provided in :samp:`{string}`.\n\
At present, the hook is used by Objective-C only, to obtain a\n\
- common-format string object when the target provides one.",
+common-format string object when the target provides one.",
tree, (tree string),
NULL)
DEFHOOK
(objc_declare_unresolved_class_reference,
- "Declare that Objective C class @var{classname} is referenced\n\
+ "Declare that Objective C class :samp:`{classname}` is referenced\n\
by the current TU.",
void, (const char *classname),
NULL)
DEFHOOK
(objc_declare_class_definition,
- "Declare that Objective C class @var{classname} is defined\n\
+ "Declare that Objective C class :samp:`{classname}` is defined\n\
by the current TU.",
void, (const char *classname),
NULL)
@@ -75,16 +75,16 @@ by the current TU.",
DEFHOOK
(string_object_ref_type_p,
"If a target implements string objects then this hook should return\n\
-@code{true} if @var{stringref} is a valid reference to such an object.",
+``true`` if :samp:`{stringref}` is a valid reference to such an object.",
bool, (const_tree stringref),
hook_bool_const_tree_false)
DEFHOOK
(check_string_object_format_arg,
"If a target implements string objects then this hook should\n\
-provide a facility to check the function arguments in @var{args_list}\n\
-against the format specifiers in @var{format_arg} where the type of\n\
-@var{format_arg} is one recognized as a valid string reference type.",
+provide a facility to check the function arguments in :samp:`{args_list}`\n\
+against the format specifiers in :samp:`{format_arg}` where the type of\n\
+:samp:`{format_arg}` is one recognized as a valid string reference type.",
void, (tree format_arg, tree args_list),
NULL)
@@ -92,9 +92,9 @@ DEFHOOK
(c_preinclude,
"Define this hook to return the name of a header file to be included at\n\
the start of all compilations, as if it had been included with\n\
-@code{#include <@var{file}>}. If this hook returns @code{NULL}, or is\n\
+``#include <file>``. If this hook returns ``NULL``, or is\n\
not defined, or the header is not found, or if the user specifies\n\
-@option{-ffreestanding} or @option{-nostdinc}, no header is included.\n\
+:option:`-ffreestanding` or :option:`-nostdinc`, no header is included.\n\
\n\
This hook can be used together with a header provided by the system C\n\
library to implement ISO C requirements for certain macros to be\n\
diff --git a/gcc/common/common-target.def b/gcc/common/common-target.def
index c4c6230073a..12a60b40e3e 100644
--- a/gcc/common/common-target.def
+++ b/gcc/common/common-target.def
@@ -39,7 +39,7 @@ DEFHOOK
DEFHOOK
(option_init_struct,
-"Set target-dependent initial values of fields in @var{opts}.",
+ "Set target-dependent initial values of fields in :samp:`{opts}`.",
void, (struct gcc_options *opts),
hook_void_gcc_optionsp)
@@ -65,17 +65,17 @@ DEFHOOK
DEFHOOK
(supports_split_stack,
"Whether this target supports splitting the stack when the options\n\
-described in @var{opts} have been passed. This is called\n\
+described in :samp:`{opts}` have been passed. This is called\n\
after options have been parsed, so the target may reject splitting\n\
the stack in some configurations. The default version of this hook\n\
-returns false. If @var{report} is true, this function may issue a warning\n\
-or error; if @var{report} is false, it must simply return a value",
+returns false. If :samp:`{report}` is true, this function may issue a warning\n\
+or error; if :samp:`{report}` is false, it must simply return a value",
bool, (bool report, struct gcc_options *opts),
hook_bool_bool_gcc_optionsp_false)
DEFHOOK
(get_valid_option_values,
-"The hook is used for options that have a non-trivial list of\n\
+ "The hook is used for options that have a non-trivial list of\n\
possible option values. OPTION_CODE is option code of opt_code\n\
enum type. PREFIX is used for bash completion and allows an implementation\n\
to return more specific completion based on the prefix. All string values\n\
@@ -89,16 +89,16 @@ DEFHOOK
"Some targets like RISC-V might have complicated multilib reuse rules which\n\
are hard to implement with the current multilib scheme. This hook allows\n\
targets to override the result from the built-in multilib mechanism.\n\
-@var{switches} is the raw option list with @var{n_switches} items;\n\
-@var{multilib_dir} is the multi-lib result which is computed by the built-in\n\
+:samp:`{switches}` is the raw option list with :samp:`{n_switches}` items;\n\
+:samp:`{multilib_dir}` is the multi-lib result which is computed by the built-in\n\
multi-lib mechanism;\n\
-@var{multilib_defaults} is the default options list for multi-lib;\n\
-@var{multilib_select} is the string containing the list of supported\n\
+:samp:`{multilib_defaults}` is the default options list for multi-lib;\n\
+:samp:`{multilib_select}` is the string containing the list of supported\n\
multi-libs, and the option checking list.\n\
-@var{multilib_matches}, @var{multilib_exclusions}, and @var{multilib_reuse}\n\
-are corresponding to @var{MULTILIB_MATCHES}, @var{MULTILIB_EXCLUSIONS},\n\
-and @var{MULTILIB_REUSE}.\n\
-The default definition does nothing but return @var{multilib_dir} directly.",
+:samp:`{multilib_matches}`, :samp:`{multilib_exclusions}`, and :samp:`{multilib_reuse}`\n\
+are corresponding to :samp:`{MULTILIB_MATCHES}`, :samp:`{MULTILIB_EXCLUSIONS}`,\n\
+and :samp:`{MULTILIB_REUSE}`.\n\
+The default definition does nothing but return :samp:`{multilib_dir}` directly.",
const char *, (const struct switchstr *switches,
int n_switches,
const char *multilib_dir,
@@ -125,7 +125,7 @@ DEFHOOKPOD
DEFHOOKPOD
(always_strip_dotdot,
- "True if @file{..} components should always be removed from directory names\n\
+ "True if :samp:`..` components should always be removed from directory names\n\
computed relative to GCC's internal directories, false (default) if such\n\
components should be preserved and directory names containing them passed\n\
to other tools such as the linker.",
diff --git a/gcc/d/d-target.def b/gcc/d/d-target.def
index 7d999d0be0b..bfdf4c4aad2 100644
--- a/gcc/d/d-target.def
+++ b/gcc/d/d-target.def
@@ -32,7 +32,7 @@ HOOK_VECTOR (TARGETDM_INITIALIZER, gcc_targetdm)
DEFHOOK
(d_cpu_versions,
"Declare all environmental version identifiers relating to the target CPU\n\
-using the function @code{builtin_version}, which takes a string representing\n\
+using the function ``builtin_version``, which takes a string representing\n\
the name of the version. Version identifiers predefined by this hook apply\n\
to all modules that are being compiled and imported.",
void, (void),
@@ -41,7 +41,7 @@ to all modules that are being compiled and imported.",
/* Environmental version identifiers relating to the target OS. */
DEFHOOK
(d_os_versions,
- "Similarly to @code{TARGET_D_CPU_VERSIONS}, but is used for versions\n\
+ "Similarly to ``TARGET_D_CPU_VERSIONS``, but is used for versions\n\
relating to the target operating system.",
void, (void),
hook_void_void)
@@ -50,10 +50,10 @@ relating to the target operating system.",
DEFHOOK
(d_register_cpu_target_info,
"Register all target information keys relating to the target CPU using the\n\
-function @code{d_add_target_info_handlers}, which takes a\n\
-@samp{struct d_target_info_spec} (defined in @file{d/d-target.h}). The keys\n\
+function ``d_add_target_info_handlers``, which takes a\n\
+:samp:`struct d_target_info_spec` (defined in :samp:`d/d-target.h`). The keys\n\
added by this hook are made available at compile time by the\n\
-@code{__traits(getTargetInfo)} extension, the result is an expression\n\
+``__traits(getTargetInfo)`` extension, the result is an expression\n\
describing the requested target information.",
void, (void),
hook_void_void)
@@ -61,7 +61,7 @@ describing the requested target information.",
/* getTargetInfo keys relating to the target OS. */
DEFHOOK
(d_register_os_target_info,
- "Same as @code{TARGET_D_CPU_TARGET_INFO}, but is used for keys relating to\n\
+ "Same as ``TARGET_D_CPU_TARGET_INFO``, but is used for keys relating to\n\
the target operating system.",
void, (void),
hook_void_void)
@@ -71,25 +71,25 @@ DEFHOOKPOD
(d_minfo_section,
"Contains the name of the section in which module info references should be\n\
placed. By default, the compiler puts all module info symbols in the\n\
-@code{\"minfo\"} section. Define this macro to override the string if a\n\
+``\"minfo\"`` section. Define this macro to override the string if a\n\
different section name should be used. This section is expected to be\n\
-bracketed by two symbols @code{TARGET_D_MINFO_SECTION_START} and \n\
-@code{TARGET_D_MINFO_SECTION_END} to indicate the start and end address of\n\
+bracketed by two symbols ``TARGET_D_MINFO_SECTION_START`` and \n\
+``TARGET_D_MINFO_SECTION_END`` to indicate the start and end address of\n\
the section, so that the runtime library can collect all modules for each\n\
-loaded shared library and executable. Setting the value to @code{NULL}\n\
+loaded shared library and executable. Setting the value to ``NULL``\n\
disables the use of sections for storing module info altogether.",
const char *, "minfo")
DEFHOOKPOD
(d_minfo_section_start,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the start address of the module info\n\
section",
const char *, "__start_minfo")
DEFHOOKPOD
(d_minfo_section_end,
- "If @code{TARGET_D_MINFO_SECTION} is defined, then this must also be defined\n\
+ "If ``TARGET_D_MINFO_SECTION`` is defined, then this must also be defined\n\
as the name of the symbol indicating the end address of the module info\n\
section",
const char *, "__stop_minfo")
@@ -99,11 +99,11 @@ section",
on declarations with `extern(System)' and `extern(Windows)' linkage. */
DEFHOOK
(d_has_stdcall_convention,
- "Returns @code{true} if the target supports the stdcall calling convention.\n\
-The hook should also set @var{link_system} to @code{1} if the @code{stdcall}\n\
-attribute should be applied to functions with @code{extern(System)} linkage,\n\
-and @var{link_windows} to @code{1} to apply @code{stdcall} to functions with\n\
-@code{extern(Windows)} linkage.",
+ "Returns ``true`` if the target supports the stdcall calling convention.\n\
+The hook should also set :samp:`{link_system}` to ``1`` if the ``stdcall``\n\
+attribute should be applied to functions with ``extern(System)`` linkage,\n\
+and :samp:`{link_windows}` to ``1`` to apply ``stdcall`` to functions with\n\
+``extern(Windows)`` linkage.",
bool, (unsigned int *link_system, unsigned int *link_windows),
hook_bool_uintp_uintp_false)
@@ -112,7 +112,7 @@ DEFHOOKPOD
(d_templates_always_comdat,
"This flag is true if instantiated functions and variables are always COMDAT\n\
if they have external linkage. If this flag is false, then instantiated\n\
-decls will be emitted as weak symbols. The default is @code{false}.",
+decls will be emitted as weak symbols. The default is ``false``.",
bool, false)
/* Close the 'struct gcc_targetdm' definition. */
diff --git a/gcc/target.def b/gcc/target.def
index 25f94c19fa7..7751b7fe7b1 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -44,25 +44,11 @@ DEFHOOKPODX (close_paren, const char *, ")")
/* Assembler instructions for creating various kinds of integer object. */
DEFHOOKPOD
(byte_op,
- "@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_ALIGNED_TI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_HI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PSI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_SI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PDI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_DI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_PTI_OP\n\
-@deftypevrx {Target Hook} {const char *} TARGET_ASM_UNALIGNED_TI_OP\n\
-These hooks specify assembly directives for creating certain kinds\n\
-of integer object. The @code{TARGET_ASM_BYTE_OP} directive creates a\n\
-byte-sized object, the @code{TARGET_ASM_ALIGNED_HI_OP} one creates an\n\
+ "These hooks specify assembly directives for creating certain kinds\n\
+of integer object. The ``TARGET_ASM_BYTE_OP`` directive creates a\n\
+byte-sized object, the ``TARGET_ASM_ALIGNED_HI_OP`` one creates an\n\
aligned two-byte object, and so on. Any of the hooks may be\n\
-@code{NULL}, indicating that no suitable directive is available.\n\
+``NULL``, indicating that no suitable directive is available.\n\
\n\
The compiler will print these strings at the start of a new line,\n\
followed immediately by the object's initial value. In most cases,\n\
@@ -78,16 +64,16 @@ DEFHOOKPOD (unaligned_op, "*", struct asm_int_op, TARGET_ASM_UNALIGNED_INT_OP)
and UNALIGNED_OP are NULL. */
DEFHOOK
(integer,
- "The @code{assemble_integer} function uses this hook to output an\n\
-integer object. @var{x} is the object's value, @var{size} is its size\n\
-in bytes and @var{aligned_p} indicates whether it is aligned. The\n\
-function should return @code{true} if it was able to output the\n\
-object. If it returns false, @code{assemble_integer} will try to\n\
+ "The ``assemble_integer`` function uses this hook to output an\n\
+integer object. :samp:`{x}` is the object's value, :samp:`{size}` is its size\n\
+in bytes and :samp:`{aligned_p}` indicates whether it is aligned. The\n\
+function should return ``true`` if it was able to output the\n\
+object. If it returns false, ``assemble_integer`` will try to\n\
split the object into smaller parts.\n\
\n\
The default implementation of this hook will use the\n\
-@code{TARGET_ASM_BYTE_OP} family of strings, returning @code{false}\n\
-when the relevant string is @code{NULL}.",
+``TARGET_ASM_BYTE_OP`` family of strings, returning ``false``\n\
+when the relevant string is ``NULL``.",
/* Only handles cases for which BYTE_OP, ALIGNED_OP and UNALIGNED_OP are
NULL. */
bool, (rtx x, unsigned int size, int aligned_p),
@@ -96,10 +82,10 @@ when the relevant string is @code{NULL}.",
/* Assembly strings required after the .cfi_startproc label. */
DEFHOOK
(post_cfi_startproc,
- "This target hook is used to emit assembly strings required by the target\n\
+ "This target hook is used to emit assembly strings required by the target\n\
after the .cfi_startproc directive. The first argument is the file stream to\n\
-write the strings to and the second argument is the function\'s declaration. The\n\
-expected use is to add more .cfi_* directives.\n\
+write the strings to and the second argument is the function's declaration. The\n\
+expected use is to add more .cfi_\\* directives.\n\
\n\
The default is to not output any assembly strings.",
void, (FILE *, tree),
@@ -118,11 +104,11 @@ terminate an initialized variable declaration.",
DEFHOOK
(globalize_label,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the label @var{name} global;\n\
+:samp:`{stream}` some commands that will make the label :samp:`{name}` global;\n\
that is, available for reference from other files.\n\
\n\
The default implementation relies on a proper definition of\n\
-@code{GLOBAL_ASM_OP}.",
+``GLOBAL_ASM_OP``.",
void, (FILE *stream, const char *name),
default_globalize_label)
@@ -130,7 +116,7 @@ The default implementation relies on a proper definition of\n\
DEFHOOK
(globalize_decl_name,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will make the name associated with @var{decl}\n\
+:samp:`{stream}` some commands that will make the name associated with :samp:`{decl}`\n\
global; that is, available for reference from other files.\n\
\n\
The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
@@ -140,8 +126,8 @@ The default implementation uses the TARGET_ASM_GLOBALIZE_LABEL target hook.",
DEFHOOK
(assemble_undefined_decl,
"This target hook is a function to output to the stdio stream\n\
-@var{stream} some commands that will declare the name associated with\n\
-@var{decl} which is not defined in the current translation unit. Most\n\
+:samp:`{stream}` some commands that will declare the name associated with\n\
+:samp:`{decl}` which is not defined in the current translation unit. Most\n\
assemblers do not require anything to be output in this case.",
void, (FILE *stream, const char *name, const_tree decl),
hook_void_FILEptr_constcharptr_const_tree)
@@ -153,13 +139,13 @@ assemblers do not require anything to be output in this case.",
this is only a placeholder for an omitted FDE. */
DEFHOOK
(emit_unwind_label,
- "This target hook emits a label at the beginning of each FDE@. It\n\
+ "This target hook emits a label at the beginning of each FDE. It\n\
should be defined on targets where FDEs need special labels, and it\n\
should write the appropriate label, for the FDE associated with the\n\
-function declaration @var{decl}, to the stdio stream @var{stream}.\n\
-The third argument, @var{for_eh}, is a boolean: true if this is for an\n\
-exception table. The fourth argument, @var{empty}, is a boolean:\n\
-true if this is a placeholder label for an omitted FDE@.\n\
+function declaration :samp:`{decl}`, to the stdio stream :samp:`{stream}`.\n\
+The third argument, :samp:`{for_eh}`, is a boolean: true if this is for an\n\
+exception table. The fourth argument, :samp:`{empty}`, is a boolean:\n\
+true if this is a placeholder label for an omitted FDE.\n\
\n\
The default is that FDEs are not given nonlocal labels.",
void, (FILE *stream, tree decl, int for_eh, int empty),
@@ -179,7 +165,7 @@ The default is that no label is emitted.",
/* Emit a directive for setting the personality for the function. */
DEFHOOK
(emit_except_personality,
- "If the target implements @code{TARGET_ASM_UNWIND_EMIT}, this hook may be\n\
+ "If the target implements ``TARGET_ASM_UNWIND_EMIT``, this hook may be\n\
used to emit a directive to install a personality hook into the unwind\n\
info. This hook should not be used if dwarf2 unwind info is used.",
void, (rtx personality),
@@ -190,7 +176,7 @@ info. This hook should not be used if dwarf2 unwind info is used.",
DEFHOOK
(make_eh_symbol_indirect,
"If necessary, modify personality and LSDA references to handle indirection.\n\
-The original symbol is in @code{origsymbol} and if @code{pubvis} is true\n\
+The original symbol is in ``origsymbol`` and if ``pubvis`` is true\n\
the symbol is visible outside the TU.",
rtx, (rtx origsymbol, bool pubvis),
NULL)
@@ -199,15 +185,15 @@ the symbol is visible outside the TU.",
DEFHOOK
(unwind_emit,
"This target hook emits assembly directives required to unwind the\n\
-given instruction. This is only used when @code{TARGET_EXCEPT_UNWIND_INFO}\n\
-returns @code{UI_TARGET}.",
+given instruction. This is only used when ``TARGET_EXCEPT_UNWIND_INFO``\n\
+returns ``UI_TARGET``.",
void, (FILE *stream, rtx_insn *insn),
NULL)
DEFHOOKPOD
(unwind_emit_before_insn,
- "True if the @code{TARGET_ASM_UNWIND_EMIT} hook should be called before\n\
-the assembly for @var{insn} has been emitted, false if the hook should\n\
+ "True if the ``TARGET_ASM_UNWIND_EMIT`` hook should be called before\n\
+the assembly for :samp:`{insn}` has been emitted, false if the hook should\n\
be called afterward.",
bool, true)
@@ -236,8 +222,8 @@ DEFHOOK_UNDOC
/* Output an internal label. */
DEFHOOK
(internal_label,
- "A function to output to the stdio stream @var{stream} a label whose\n\
-name is made from the string @var{prefix} and the number @var{labelno}.\n\
+ "A function to output to the stdio stream :samp:`{stream}` a label whose\n\
+name is made from the string :samp:`{prefix}` and the number :samp:`{labelno}`.\n\
\n\
It is absolutely essential that these labels be distinct from the labels\n\
used for user-level functions and variables. Otherwise, certain programs\n\
@@ -245,28 +231,28 @@ will have name conflicts with internal labels.\n\
\n\
It is desirable to exclude internal labels from the symbol table of the\n\
object file. Most assemblers have a naming convention for labels that\n\
-should be excluded; on many systems, the letter @samp{L} at the\n\
+should be excluded; on many systems, the letter :samp:`L` at the\n\
beginning of a label has this effect. You should find out what\n\
convention your system uses, and follow it.\n\
\n\
-The default version of this function utilizes @code{ASM_GENERATE_INTERNAL_LABEL}.",
+The default version of this function utilizes ``ASM_GENERATE_INTERNAL_LABEL``.",
void, (FILE *stream, const char *prefix, unsigned long labelno),
default_internal_label)
/* Output label for the constant. */
DEFHOOK
(declare_constant_name,
- "A target hook to output to the stdio stream @var{file} any text necessary\n\
-for declaring the name @var{name} of a constant which is being defined. This\n\
+ "A target hook to output to the stdio stream :samp:`{file}` any text necessary\n\
+for declaring the name :samp:`{name}` of a constant which is being defined. This\n\
target hook is responsible for outputting the label definition (perhaps using\n\
-@code{assemble_label}). The argument @var{exp} is the value of the constant,\n\
-and @var{size} is the size of the constant in bytes. The @var{name}\n\
+``assemble_label``). The argument :samp:`{exp}` is the value of the constant,\n\
+and :samp:`{size}` is the size of the constant in bytes. The :samp:`{name}`\n\
will be an internal label.\n\
\n\
-The default version of this target hook, define the @var{name} in the\n\
-usual manner as a label (by means of @code{assemble_label}).\n\
+The default version of this target hook, define the :samp:`{name}` in the\n\
+usual manner as a label (by means of ``assemble_label``).\n\
\n\
-You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
+You may wish to use ``ASM_OUTPUT_TYPE_DIRECTIVE`` in this target hook.",
void, (FILE *file, const char *name, const_tree expr, HOST_WIDE_INT size),
default_asm_declare_constant_name)
@@ -274,8 +260,8 @@ You may wish to use @code{ASM_OUTPUT_TYPE_DIRECTIVE} in this target hook.",
DEFHOOK
(ttype,
"This hook is used to output a reference from a frame unwinding table to\n\
-the type_info object identified by @var{sym}. It should return @code{true}\n\
-if the reference was output. Returning @code{false} will cause the\n\
+the type_info object identified by :samp:`{sym}`. It should return ``true``\n\
+if the reference was output. Returning ``false`` will cause the\n\
reference to be output using the normal Dwarf2 routines.",
bool, (rtx sym),
hook_bool_rtx_false)
@@ -284,20 +270,20 @@ reference to be output using the normal Dwarf2 routines.",
associated with the tree decl. */
DEFHOOK
(assemble_visibility,
- "This target hook is a function to output to @var{asm_out_file} some\n\
-commands that will make the symbol(s) associated with @var{decl} have\n\
-hidden, protected or internal visibility as specified by @var{visibility}.",
+ "This target hook is a function to output to :samp:`{asm_out_file}` some\n\
+commands that will make the symbol(s) associated with :samp:`{decl}` have\n\
+hidden, protected or internal visibility as specified by :samp:`{visibility}`.",
void, (tree decl, int visibility),
default_assemble_visibility)
DEFHOOK
(print_patchable_function_entry,
"Generate a patchable area at the function start, consisting of\n\
-@var{patch_area_size} NOP instructions. If the target supports named\n\
-sections and if @var{record_p} is true, insert a pointer to the current\n\
+:samp:`{patch_area_size}` NOP instructions. If the target supports named\n\
+sections and if :samp:`{record_p}` is true, insert a pointer to the current\n\
location in the table of patchable functions. The default implementation\n\
of the hook places the table of pointers in the special section named\n\
-@code{__patchable_function_entries}.",
+``__patchable_function_entries``.",
void, (FILE *file, unsigned HOST_WIDE_INT patch_area_size, bool record_p),
default_print_patchable_function_entry)
@@ -307,40 +293,42 @@ DEFHOOK
"If defined, a function that outputs the assembler code for entry to a\n\
function. The prologue is responsible for setting up the stack frame,\n\
initializing the frame pointer register, saving registers that must be\n\
-saved, and allocating @var{size} additional bytes of storage for the\n\
-local variables. @var{file} is a stdio stream to which the assembler\n\
+saved, and allocating :samp:`{size}` additional bytes of storage for the\n\
+local variables. :samp:`{file}` is a stdio stream to which the assembler\n\
code should be output.\n\
\n\
The label for the beginning of the function need not be output by this\n\
macro. That has already been done when the macro is run.\n\
\n\
-@findex regs_ever_live\n\
+.. index:: regs_ever_live\n\
+\n\
To determine which registers to save, the macro can refer to the array\n\
-@code{regs_ever_live}: element @var{r} is nonzero if hard register\n\
-@var{r} is used anywhere within the function. This implies the function\n\
-prologue should save register @var{r}, provided it is not one of the\n\
-call-used registers. (@code{TARGET_ASM_FUNCTION_EPILOGUE} must likewise use\n\
-@code{regs_ever_live}.)\n\
+``regs_ever_live`` : element :samp:`{r}` is nonzero if hard register\n\
+:samp:`{r}` is used anywhere within the function. This implies the function\n\
+prologue should save register :samp:`{r}`, provided it is not one of the\n\
+call-used registers. (``TARGET_ASM_FUNCTION_EPILOGUE`` must likewise use\n\
+``regs_ever_live``.)\n\
\n\
-On machines that have ``register windows'', the function entry code does\n\
+On machines that have 'register windows', the function entry code does\n\
not save on the stack the registers that are in the windows, even if\n\
they are supposed to be preserved by function calls; instead it takes\n\
-appropriate steps to ``push'' the register stack, if any non-call-used\n\
+appropriate steps to 'push' the register stack, if any non-call-used\n\
registers are used in the function.\n\
\n\
-@findex frame_pointer_needed\n\
+.. index:: frame_pointer_needed\n\
+\n\
On machines where functions may or may not have frame-pointers, the\n\
function entry code must vary accordingly; it must set up the frame\n\
pointer if one is wanted, and not otherwise. To determine whether a\n\
frame pointer is in wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 at run\n\
-time in a function that needs a frame pointer. @xref{Elimination}.\n\
+``frame_pointer_needed``. The variable's value will be 1 at run\n\
+time in a function that needs a frame pointer. See :ref:`elimination`.\n\
\n\
The function entry code is responsible for allocating any stack space\n\
required for the function. This stack space consists of the regions\n\
listed below. In most cases, these regions are allocated in the\n\
order listed, with the last listed region closest to the top of the\n\
-stack (the lowest address if @code{STACK_GROWS_DOWNWARD} is defined, and\n\
+stack (the lowest address if ``STACK_GROWS_DOWNWARD`` is defined, and\n\
the highest address if it is not defined). You can use a different order\n\
for a machine if doing so is more convenient or required for\n\
compatibility reasons. Except in cases where required by standard\n\
@@ -355,7 +343,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the end of a\n\
prologue. This should be used when the function prologue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{prologue instruction pattern}.",
+emitted. See :ref:`prologue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -365,7 +353,7 @@ DEFHOOK
"If defined, a function that outputs assembler code at the start of an\n\
epilogue. This should be used when the function epilogue is being\n\
emitted as RTL, and you have some extra assembler that needs to be\n\
-emitted. @xref{epilogue instruction pattern}.",
+emitted. See :ref:`epilogue-instruction-pattern`.",
void, (FILE *file),
no_asm_to_stream)
@@ -376,46 +364,46 @@ DEFHOOK
function. The epilogue is responsible for restoring the saved\n\
registers and stack pointer to their values when the function was\n\
called, and returning control to the caller. This macro takes the\n\
-same argument as the macro @code{TARGET_ASM_FUNCTION_PROLOGUE}, and the\n\
-registers to restore are determined from @code{regs_ever_live} and\n\
-@code{CALL_USED_REGISTERS} in the same way.\n\
+same argument as the macro ``TARGET_ASM_FUNCTION_PROLOGUE``, and the\n\
+registers to restore are determined from ``regs_ever_live`` and\n\
+``CALL_USED_REGISTERS`` in the same way.\n\
\n\
On some machines, there is a single instruction that does all the work\n\
of returning from the function. On these machines, give that\n\
-instruction the name @samp{return} and do not define the macro\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} at all.\n\
+instruction the name :samp:`return` and do not define the macro\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` at all.\n\
\n\
-Do not define a pattern named @samp{return} if you want the\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} to be used. If you want the target\n\
+Do not define a pattern named :samp:`return` if you want the\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` to be used. If you want the target\n\
switches to control whether return instructions or epilogues are used,\n\
-define a @samp{return} pattern with a validity condition that tests the\n\
-target switches appropriately. If the @samp{return} pattern's validity\n\
+define a :samp:`return` pattern with a validity condition that tests the\n\
+target switches appropriately. If the :samp:`return` pattern's validity\n\
condition is false, epilogues will be used.\n\
\n\
On machines where functions may or may not have frame-pointers, the\n\
function exit code must vary accordingly. Sometimes the code for these\n\
two cases is completely different. To determine whether a frame pointer\n\
is wanted, the macro can refer to the variable\n\
-@code{frame_pointer_needed}. The variable's value will be 1 when compiling\n\
+``frame_pointer_needed``. The variable's value will be 1 when compiling\n\
a function that needs a frame pointer.\n\
\n\
-Normally, @code{TARGET_ASM_FUNCTION_PROLOGUE} and\n\
-@code{TARGET_ASM_FUNCTION_EPILOGUE} must treat leaf functions specially.\n\
-The C variable @code{current_function_is_leaf} is nonzero for such a\n\
-function. @xref{Leaf Functions}.\n\
+Normally, ``TARGET_ASM_FUNCTION_PROLOGUE`` and\n\
+``TARGET_ASM_FUNCTION_EPILOGUE`` must treat leaf functions specially.\n\
+The C variable ``current_function_is_leaf`` is nonzero for such a\n\
+function. See :ref:`leaf-functions`.\n\
\n\
On some machines, some functions pop their arguments on exit while\n\
others leave that for the caller to do. For example, the 68020 when\n\
-given @option{-mrtd} pops arguments in functions that take a fixed\n\
+given :option:`-mrtd` pops arguments in functions that take a fixed\n\
number of arguments.\n\
\n\
-@findex pops_args\n\
-@findex crtl->args.pops_args\n\
-Your definition of the macro @code{RETURN_POPS_ARGS} decides which\n\
-functions pop their own arguments. @code{TARGET_ASM_FUNCTION_EPILOGUE}\n\
+.. index:: pops_args, crtl->args.pops_args\n\
+\n\
+Your definition of the macro ``RETURN_POPS_ARGS`` decides which\n\
+functions pop their own arguments. ``TARGET_ASM_FUNCTION_EPILOGUE``\n\
needs to know what was decided. The number of bytes of the current\n\
function's arguments that this function should pop is available in\n\
-@code{crtl->args.pops_args}. @xref{Scalar Return}.",
+``crtl->args.pops_args``. See :ref:`scalar-return`.",
void, (FILE *file),
default_function_pro_epilogue)
@@ -423,7 +411,7 @@ function's arguments that this function should pop is available in\n\
DEFHOOK
(init_sections,
"Define this hook if you need to do something special to set up the\n\
-@file{varasm.cc} sections, or if your target has some special sections\n\
+:samp:`varasm.cc` sections, or if your target has some special sections\n\
of its own that you need to create.\n\
\n\
GCC calls this hook after processing the command line, but before writing\n\
@@ -437,10 +425,10 @@ described below.",
which this section is associated. */
DEFHOOK
(named_section,
- "Output assembly directives to switch to section @var{name}. The section\n\
-should have attributes as specified by @var{flags}, which is a bit mask\n\
-of the @code{SECTION_*} flags defined in @file{output.h}. If @var{decl}\n\
-is non-NULL, it is the @code{VAR_DECL} or @code{FUNCTION_DECL} with which\n\
+ "Output assembly directives to switch to section :samp:`{name}`. The section\n\
+should have attributes as specified by :samp:`{flags}`, which is a bit mask\n\
+of the ``SECTION_*`` flags defined in :samp:`output.h`. If :samp:`{decl}`\n\
+is non-NULL, it is the ``VAR_DECL`` or ``FUNCTION_DECL`` with which\n\
this section is associated.",
void, (const char *name, unsigned int flags, tree decl),
default_no_named_section)
@@ -451,12 +439,12 @@ DEFHOOK
(elf_flags_numeric,
"This hook can be used to encode ELF section flags for which no letter\n\
code has been defined in the assembler. It is called by\n\
-@code{default_asm_named_section} whenever the section flags need to be\n\
+``default_asm_named_section`` whenever the section flags need to be\n\
emitted in the assembler output. If the hook returns true, then the\n\
numerical value for ELF section flags should be calculated from\n\
-@var{flags} and saved in @var{*num}; the value is printed out instead of the\n\
+:samp:`{flags}` and saved in :samp:`{*num}` ; the value is printed out instead of the\n\
normal sequence of letter codes. If the hook is not defined, or if it\n\
-returns false, then @var{num} is ignored and the traditional letter sequence\n\
+returns false, then :samp:`{num}` is ignored and the traditional letter sequence\n\
is emitted.",
bool, (unsigned int flags, unsigned int *num),
hook_bool_uint_uintp_false)
@@ -470,11 +458,11 @@ is emitted.",
Return NULL if function should go to default text section. */
DEFHOOK
(function_section,
- "Return preferred text (sub)section for function @var{decl}.\n\
+ "Return preferred text (sub)section for function :samp:`{decl}`.\n\
Main purpose of this function is to separate cold, normal and hot\n\
-functions. @var{startup} is true when function is known to be used only\n\
-at startup (from static constructors or it is @code{main()}).\n\
-@var{exit} is true when function is known to be used only at exit\n\
+functions. :samp:`{startup}` is true when function is known to be used only\n\
+at startup (from static constructors or it is ``main()``).\n\
+:samp:`{exit}` is true when function is known to be used only at exit\n\
(from static destructors).\n\
Return NULL if function should go to default text section.",
section *, (tree decl, enum node_frequency freq, bool startup, bool exit),
@@ -485,9 +473,9 @@ DEFHOOK
(function_switched_text_sections,
"Used by the target to emit any assembler directives or additional\n\
labels needed when a function is partitioned between different\n\
-sections. Output should be written to @var{file}. The function\n\
-decl is available as @var{decl} and the new section is `cold' if\n\
-@var{new_is_cold} is @code{true}.",
+sections. Output should be written to :samp:`{file}`. The function\n\
+decl is available as :samp:`{decl}` and the new section is 'cold' if\n\
+:samp:`{new_is_cold}` is ``true``.",
void, (FILE *file, tree decl, bool new_is_cold),
default_function_switched_text_sections)
@@ -502,7 +490,7 @@ selecting sections. Bit 1 should be set if global relocations\n\
should be placed in a read-write section; bit 0 should be set if\n\
local relocations should be placed in a read-write section.\n\
\n\
-The default version of this function returns 3 when @option{-fpic}\n\
+The default version of this function returns 3 when :option:`-fpic`\n\
is in effect, and 0 otherwise. The hook is typically redefined\n\
when the target cannot support (some kinds of) dynamic relocations\n\
in read-only sections even in executables.",
@@ -513,7 +501,7 @@ in read-only sections even in executables.",
or ADDR_VEC table for jumps in case of -fPIC/-fPIE. */
DEFHOOK
(generate_pic_addr_diff_vec,
-"Return true to generate ADDR_DIF_VEC table\n\
+ "Return true to generate ADDR_DIF_VEC table\n\
or false to generate ADDR_VEC table for jumps in case of -fPIC.\n\
\n\
The default version of this function returns true if flag_pic\n\
@@ -527,17 +515,17 @@ equals true and false otherwise",
ALIGN is the required alignment of the data. */
DEFHOOK
(select_section,
- "Return the section into which @var{exp} should be placed. You can\n\
-assume that @var{exp} is either a @code{VAR_DECL} node or a constant of\n\
-some sort. @var{reloc} indicates whether the initial value of @var{exp}\n\
+ "Return the section into which :samp:`{exp}` should be placed. You can\n\
+assume that :samp:`{exp}` is either a ``VAR_DECL`` node or a constant of\n\
+some sort. :samp:`{reloc}` indicates whether the initial value of :samp:`{exp}`\n\
requires link-time relocations. Bit 0 is set when variable contains\n\
local relocations only, while bit 1 is set for global relocations.\n\
-@var{align} is the constant alignment in bits.\n\
+:samp:`{align}` is the constant alignment in bits.\n\
\n\
The default version of this function takes care of putting read-only\n\
-variables in @code{readonly_data_section}.\n\
+variables in ``readonly_data_section``.\n\
\n\
-See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
+See also :samp:`{USE_SELECT_SECTION_FOR_FUNCTIONS}`.",
section *, (tree exp, int reloc, unsigned HOST_WIDE_INT align),
default_select_section)
@@ -545,15 +533,15 @@ See also @var{USE_SELECT_SECTION_FOR_FUNCTIONS}.",
alignment in bits. */
DEFHOOK
(select_rtx_section,
- "Return the section into which a constant @var{x}, of mode @var{mode},\n\
-should be placed. You can assume that @var{x} is some kind of\n\
-constant in RTL@. The argument @var{mode} is redundant except in the\n\
-case of a @code{const_int} rtx. @var{align} is the constant alignment\n\
+ "Return the section into which a constant :samp:`{x}`, of mode :samp:`{mode}`,\n\
+should be placed. You can assume that :samp:`{x}` is some kind of\n\
+constant in RTL. The argument :samp:`{mode}` is redundant except in the\n\
+case of a ``const_int`` rtx. :samp:`{align}` is the constant alignment\n\
in bits.\n\
\n\
The default version of this function takes care of putting symbolic\n\
-constants in @code{flag_pic} mode in @code{data_section} and everything\n\
-else in @code{readonly_data_section}.",
+constants in ``flag_pic`` mode in ``data_section`` and everything\n\
+else in ``readonly_data_section``.",
section *, (machine_mode mode, rtx x, unsigned HOST_WIDE_INT align),
default_select_rtx_section)
@@ -561,14 +549,14 @@ else in @code{readonly_data_section}.",
for SELECT_SECTION. */
DEFHOOK
(unique_section,
- "Build up a unique section name, expressed as a @code{STRING_CST} node,\n\
-and assign it to @samp{DECL_SECTION_NAME (@var{decl})}.\n\
-As with @code{TARGET_ASM_SELECT_SECTION}, @var{reloc} indicates whether\n\
-the initial value of @var{exp} requires link-time relocations.\n\
+ "Build up a unique section name, expressed as a ``STRING_CST`` node,\n\
+and assign it to :samp:`DECL_SECTION_NAME ({decl})`.\n\
+As with ``TARGET_ASM_SELECT_SECTION``, :samp:`{reloc}` indicates whether\n\
+the initial value of :samp:`{exp}` requires link-time relocations.\n\
\n\
The default version of this function appends the symbol name to the\n\
ELF section name that would normally be used for the symbol. For\n\
-example, the function @code{foo} would be placed in @code{.text.foo}.\n\
+example, the function ``foo`` would be placed in ``.text.foo``.\n\
Whatever the actual target object format, this is often good enough.",
void, (tree decl, int reloc),
default_unique_section)
@@ -578,11 +566,11 @@ Whatever the actual target object format, this is often good enough.",
DEFHOOK
(function_rodata_section,
"Return the readonly data or reloc readonly data section associated with\n\
-@samp{DECL_SECTION_NAME (@var{decl})}. @var{relocatable} selects the latter\n\
+:samp:`DECL_SECTION_NAME ({decl})`. :samp:`{relocatable}` selects the latter\n\
over the former.\n\
-The default version of this function selects @code{.gnu.linkonce.r.name} if\n\
-the function's section is @code{.gnu.linkonce.t.name}, @code{.rodata.name}\n\
-or @code{.data.rel.ro.name} if function is in @code{.text.name}, and\n\
+The default version of this function selects ``.gnu.linkonce.r.name`` if\n\
+the function's section is ``.gnu.linkonce.t.name``, ``.rodata.name``\n\
+or ``.data.rel.ro.name`` if function is in ``.text.name``, and\n\
the normal readonly-data or reloc readonly data section otherwise.",
section *, (tree decl, bool relocatable),
default_function_rodata_section)
@@ -591,7 +579,7 @@ the normal readonly-data or reloc readonly data section otherwise.",
for mergeable data sections. */
DEFHOOKPOD
(mergeable_rodata_prefix,
- "Usually, the compiler uses the prefix @code{\".rodata\"} to construct\n\
+ "Usually, the compiler uses the prefix ``\".rodata\"`` to construct\n\
section names for mergeable constant data. Define this macro to override\n\
the string if a different section name should be used.",
const char *, ".rodata")
@@ -607,23 +595,23 @@ tables.",
DEFHOOK
(constructor,
"If defined, a function that outputs assembler code to arrange to call\n\
-the function referenced by @var{symbol} at initialization time.\n\
+the function referenced by :samp:`{symbol}` at initialization time.\n\
\n\
-Assume that @var{symbol} is a @code{SYMBOL_REF} for a function taking\n\
+Assume that :samp:`{symbol}` is a ``SYMBOL_REF`` for a function taking\n\
no arguments and with no return value. If the target supports initialization\n\
-priorities, @var{priority} is a value between 0 and @code{MAX_INIT_PRIORITY};\n\
-otherwise it must be @code{DEFAULT_INIT_PRIORITY}.\n\
+priorities, :samp:`{priority}` is a value between 0 and ``MAX_INIT_PRIORITY`` ;\n\
+otherwise it must be ``DEFAULT_INIT_PRIORITY``.\n\
\n\
If this macro is not defined by the target, a suitable default will\n\
be chosen if (1) the target supports arbitrary section names, (2) the\n\
-target defines @code{CTORS_SECTION_ASM_OP}, or (3) @code{USE_COLLECT2}\n\
+target defines ``CTORS_SECTION_ASM_OP``, or (3) ``USE_COLLECT2``\n\
is not defined.",
void, (rtx symbol, int priority), NULL)
/* Output a destructor for a symbol with a given priority. */
DEFHOOK
(destructor,
- "This is like @code{TARGET_ASM_CONSTRUCTOR} but used for termination\n\
+ "This is like ``TARGET_ASM_CONSTRUCTOR`` but used for termination\n\
functions rather than initialization functions.",
void, (rtx symbol, int priority), NULL)
@@ -640,38 +628,38 @@ inheritance. The thunk acts as a wrapper around a virtual function,\n\
adjusting the implicit object parameter before handing control off to\n\
the real function.\n\
\n\
-First, emit code to add the integer @var{delta} to the location that\n\
+First, emit code to add the integer :samp:`{delta}` to the location that\n\
contains the incoming first argument. Assume that this argument\n\
-contains a pointer, and is the one used to pass the @code{this} pointer\n\
-in C++. This is the incoming argument @emph{before} the function prologue,\n\
-e.g.@: @samp{%o0} on a sparc. The addition must preserve the values of\n\
+contains a pointer, and is the one used to pass the ``this`` pointer\n\
+in C++. This is the incoming argument *before* the function prologue,\n\
+e.g. :samp:`%o0` on a sparc. The addition must preserve the values of\n\
all other incoming arguments.\n\
\n\
-Then, if @var{vcall_offset} is nonzero, an additional adjustment should be\n\
-made after adding @code{delta}. In particular, if @var{p} is the\n\
+Then, if :samp:`{vcall_offset}` is nonzero, an additional adjustment should be\n\
+made after adding ``delta``. In particular, if :samp:`{p}` is the\n\
adjusted pointer, the following adjustment should be made:\n\
\n\
-@smallexample\n\
-p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-After the additions, emit code to jump to @var{function}, which is a\n\
-@code{FUNCTION_DECL}. This is a direct pure jump, not a call, and does\n\
-not touch the return address. Hence returning from @var{FUNCTION} will\n\
-return to whoever called the current @samp{thunk}.\n\
+ p += (*((ptrdiff_t **)p))[vcall_offset/sizeof(ptrdiff_t)]\n\
\n\
-The effect must be as if @var{function} had been called directly with\n\
+After the additions, emit code to jump to :samp:`{function}`, which is a\n\
+``FUNCTION_DECL``. This is a direct pure jump, not a call, and does\n\
+not touch the return address. Hence returning from :samp:`{FUNCTION}` will\n\
+return to whoever called the current :samp:`thunk`.\n\
+\n\
+The effect must be as if :samp:`{function}` had been called directly with\n\
the adjusted first argument. This macro is responsible for emitting all\n\
-of the code for a thunk function; @code{TARGET_ASM_FUNCTION_PROLOGUE}\n\
-and @code{TARGET_ASM_FUNCTION_EPILOGUE} are not invoked.\n\
+of the code for a thunk function; ``TARGET_ASM_FUNCTION_PROLOGUE``\n\
+and ``TARGET_ASM_FUNCTION_EPILOGUE`` are not invoked.\n\
\n\
-The @var{thunk_fndecl} is redundant. (@var{delta} and @var{function}\n\
+The :samp:`{thunk_fndecl}` is redundant. (:samp:`{delta}` and :samp:`{function}`\n\
have already been extracted from it.) It might possibly be useful on\n\
some targets, but probably not.\n\
\n\
If you do not define this macro, the target-independent code in the C++\n\
front end will generate a less efficient heavyweight thunk that calls\n\
-@var{function} instead of jumping to it. The generic approach does\n\
+:samp:`{function}` instead of jumping to it. The generic approach does\n\
not support varargs.",
void, (FILE *file, tree thunk_fndecl, HOST_WIDE_INT delta,
HOST_WIDE_INT vcall_offset, tree function),
@@ -698,11 +686,11 @@ previously exposed.",
translation unit. */
DEFHOOK
(file_start,
- "Output to @code{asm_out_file} any text which the assembler expects to\n\
+ "Output to ``asm_out_file`` any text which the assembler expects to\n\
find at the beginning of a file. The default behavior is controlled\n\
by two flags, documented below. Unless your target's assembler is\n\
quite unusual, if you override the default, you should call\n\
-@code{default_file_start} at some point in your target hook. This\n\
+``default_file_start`` at some point in your target hook. This\n\
lets other target files rely on these variables.",
void, (void),
default_file_start)
@@ -710,7 +698,7 @@ lets other target files rely on these variables.",
/* Output any boilerplate text needed at the end of a translation unit. */
DEFHOOK
(file_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of a file. The default is to output nothing.",
void, (void),
hook_void_void)
@@ -719,7 +707,7 @@ to find at the end of a file. The default is to output nothing.",
LTO output stream. */
DEFHOOK
(lto_start,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the start of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -729,7 +717,7 @@ nothing.",
LTO output stream. */
DEFHOOK
(lto_end,
- "Output to @code{asm_out_file} any text which the assembler expects\n\
+ "Output to ``asm_out_file`` any text which the assembler expects\n\
to find at the end of an LTO section. The default is to output\n\
nothing.",
void, (void),
@@ -739,7 +727,7 @@ nothing.",
translation unit before debug and unwind info is emitted. */
DEFHOOK
(code_end,
- "Output to @code{asm_out_file} any text which is needed before emitting\n\
+ "Output to ``asm_out_file`` any text which is needed before emitting\n\
unwind info and debug info at the end of a file. Some targets emit\n\
here PIC setup thunks that cannot be emitted at the end of file,\n\
because they couldn't have unwind info then. The default is to output\n\
@@ -751,9 +739,9 @@ nothing.",
external. */
DEFHOOK
(external_libcall,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
pseudo-op to declare a library function name external. The name of the\n\
-library function is given by @var{symref}, which is a @code{symbol_ref}.",
+library function is given by :samp:`{symref}`, which is a ``symbol_ref``.",
void, (rtx symref),
default_external_libcall)
@@ -761,8 +749,8 @@ library function is given by @var{symref}, which is a @code{symbol_ref}.",
linker to not dead code strip this symbol. */
DEFHOOK
(mark_decl_preserved,
- "This target hook is a function to output to @var{asm_out_file} an assembler\n\
-directive to annotate @var{symbol} as used. The Darwin target uses the\n\
+ "This target hook is a function to output to :samp:`{asm_out_file}` an assembler\n\
+directive to annotate :samp:`{symbol}` as used. The Darwin target uses the\n\
.no_dead_code_strip directive.",
void, (const char *symbol),
hook_void_constcharptr)
@@ -774,10 +762,10 @@ DEFHOOK
switches provided as argument.\n\
\n\
By default this hook is set to NULL, but an example implementation is\n\
-provided for ELF based targets. Called @var{elf_record_gcc_switches},\n\
+provided for ELF based targets. Called :samp:`{elf_record_gcc_switches}`,\n\
it records the switches as ASCII text inside a new, string mergeable\n\
section in the assembler output file. The name of the new section is\n\
-provided by the @code{TARGET_ASM_RECORD_GCC_SWITCHES_SECTION} target\n\
+provided by the ``TARGET_ASM_RECORD_GCC_SWITCHES_SECTION`` target\n\
hook.",
void, (const char *),
NULL)
@@ -789,30 +777,30 @@ hook.",
DEFHOOKPOD
(record_gcc_switches_section,
"This is the name of the section that will be created by the example\n\
-ELF implementation of the @code{TARGET_ASM_RECORD_GCC_SWITCHES} target\n\
+ELF implementation of the ``TARGET_ASM_RECORD_GCC_SWITCHES`` target\n\
hook.",
const char *, ".GCC.command.line")
/* Output the definition of a section anchor. */
DEFHOOK
(output_anchor,
- "Write the assembly code to define section anchor @var{x}, which is a\n\
-@code{SYMBOL_REF} for which @samp{SYMBOL_REF_ANCHOR_P (@var{x})} is true.\n\
+ "Write the assembly code to define section anchor :samp:`{x}`, which is a\n\
+``SYMBOL_REF`` for which :samp:`SYMBOL_REF_ANCHOR_P ({x})` is true.\n\
The hook is called with the assembly output position set to the beginning\n\
-of @code{SYMBOL_REF_BLOCK (@var{x})}.\n\
+of ``SYMBOL_REF_BLOCK (x)``.\n\
\n\
-If @code{ASM_OUTPUT_DEF} is available, the hook's default definition uses\n\
-it to define the symbol as @samp{. + SYMBOL_REF_BLOCK_OFFSET (@var{x})}.\n\
-If @code{ASM_OUTPUT_DEF} is not available, the hook's default definition\n\
-is @code{NULL}, which disables the use of section anchors altogether.",
+If ``ASM_OUTPUT_DEF`` is available, the hook's default definition uses\n\
+it to define the symbol as :samp:`. + SYMBOL_REF_BLOCK_OFFSET ({x})`.\n\
+If ``ASM_OUTPUT_DEF`` is not available, the hook's default definition\n\
+is ``NULL``, which disables the use of section anchors altogether.",
void, (rtx x),
default_asm_output_anchor)
DEFHOOK
(output_ident,
- "Output a string based on @var{name}, suitable for the @samp{#ident}\n\
+ "Output a string based on :samp:`{name}`, suitable for the :samp:`#ident`\n\
directive, or the equivalent directive or pragma in non-C-family languages.\n\
-If this hook is not defined, nothing is output for the @samp{#ident}\n\
+If this hook is not defined, nothing is output for the :samp:`#ident`\n\
directive.",
void, (const char *name),
hook_void_constcharptr)
@@ -829,11 +817,11 @@ reference to the given TLS symbol of the specified size.",
DEFHOOK
(final_postscan_insn,
"If defined, this target hook is a function which is executed just after the\n\
-output of assembler code for @var{insn}, to change the mode of the assembler\n\
+output of assembler code for :samp:`{insn}`, to change the mode of the assembler\n\
if necessary.\n\
\n\
-Here the argument @var{opvec} is the vector containing the operands\n\
-extracted from @var{insn}, and @var{noperands} is the number of\n\
+Here the argument :samp:`{opvec}` is the vector containing the operands\n\
+extracted from :samp:`{insn}`, and :samp:`{noperands}` is the number of\n\
elements of the vector which contain meaningful data for this insn.\n\
The contents of this vector are what was used to convert the insn\n\
template into assembler code, so you can change the assembler mode\n\
@@ -844,8 +832,8 @@ by checking the contents of the vector.",
/* Emit the trampoline template. This hook may be NULL. */
DEFHOOK
(trampoline_template,
- "This hook is called by @code{assemble_trampoline_template} to output,\n\
-on the stream @var{f}, assembler code for a block of data that contains\n\
+ "This hook is called by ``assemble_trampoline_template`` to output,\n\
+on the stream :samp:`{f}`, assembler code for a block of data that contains\n\
the constant parts of a trampoline. This code should not include a\n\
label---the label is taken care of automatically.\n\
\n\
@@ -859,7 +847,7 @@ to generate it on the spot.",
DEFHOOK
(output_source_filename,
"Output DWARF debugging information which indicates that filename\n\
-@var{name} is the current source file to the stdio stream @var{file}.\n\
+:samp:`{name}` is the current source file to the stdio stream :samp:`{file}`.\n\
\n\
This target hook need not be defined if the standard form of output\n\
for the file format in use is appropriate.",
@@ -868,15 +856,15 @@ for the file format in use is appropriate.",
DEFHOOK
(output_addr_const_extra,
- "A target hook to recognize @var{rtx} patterns that @code{output_addr_const}\n\
-can't deal with, and output assembly code to @var{file} corresponding to\n\
-the pattern @var{x}. This may be used to allow machine-dependent\n\
-@code{UNSPEC}s to appear within constants.\n\
+ "A target hook to recognize :samp:`{rtx}` patterns that ``output_addr_const``\n\
+can't deal with, and output assembly code to :samp:`{file}` corresponding to\n\
+the pattern :samp:`{x}`. This may be used to allow machine-dependent\n\
+``UNSPEC`` s to appear within constants.\n\
\n\
-If target hook fails to recognize a pattern, it must return @code{false},\n\
+If target hook fails to recognize a pattern, it must return ``false``,\n\
so that a standard error message is printed. If it prints an error message\n\
-itself, by calling, for example, @code{output_operand_lossage}, it may just\n\
-return @code{true}.",
+itself, by calling, for example, ``output_operand_lossage``, it may just\n\
+return ``true``.",
bool, (FILE *file, rtx x),
hook_bool_FILEptr_rtx_false)
@@ -918,11 +906,11 @@ DEFHOOK_UNDOC
ASM_OUTPUT_LABELREF, returning result as an IDENTIFIER_NODE. */
DEFHOOK
(mangle_assembler_name,
- "Given a symbol @var{name}, perform same mangling as @code{varasm.cc}'s\n\
-@code{assemble_name}, but in memory rather than to a file stream, returning\n\
-result as an @code{IDENTIFIER_NODE}. Required for correct LTO symtabs. The\n\
-default implementation calls the @code{TARGET_STRIP_NAME_ENCODING} hook and\n\
-then prepends the @code{USER_LABEL_PREFIX}, if any.",
+ "Given a symbol :samp:`{name}`, perform same mangling as ``varasm.cc`` 's\n\
+``assemble_name``, but in memory rather than to a file stream, returning\n\
+result as an ``IDENTIFIER_NODE``. Required for correct LTO symtabs. The\n\
+default implementation calls the ``TARGET_STRIP_NAME_ENCODING`` hook and\n\
+then prepends the ``USER_LABEL_PREFIX``, if any.",
tree, (const char *name),
default_mangle_assembler_name)
@@ -939,10 +927,10 @@ HOOK_VECTOR (TARGET_SCHED, sched)
the dependence LINK. The default is to make no adjustment. */
DEFHOOK
(adjust_cost,
- "This function corrects the value of @var{cost} based on the\n\
-relationship between @var{insn} and @var{dep_insn} through a\n\
-dependence of type dep_type, and strength @var{dw}. It should return the new\n\
-value. The default is to make no adjustment to @var{cost}. This can be\n\
+ "This function corrects the value of :samp:`{cost}` based on the\n\
+relationship between :samp:`{insn}` and :samp:`{dep_insn}` through a\n\
+dependence of type dep_type, and strength :samp:`{dw}`. It should return the new\n\
+value. The default is to make no adjustment to :samp:`{cost}`. This can be\n\
used for example to specify to the scheduler using the traditional pipeline\n\
description that an output- or anti-dependence does not incur the same cost\n\
as a data-dependence. If the scheduler using the automaton based pipeline\n\
@@ -950,7 +938,7 @@ description, the cost of anti-dependence is zero and the cost of\n\
output-dependence is maximum of one and the difference of latency\n\
times of the first and the second insns. If these values are not\n\
acceptable, you could use the hook to modify them too. See also\n\
-@pxref{Processor pipeline description}.",
+see :ref:`processor-pipeline-description`.",
int, (rtx_insn *insn, int dep_type1, rtx_insn *dep_insn, int cost,
unsigned int dw),
NULL)
@@ -958,9 +946,9 @@ acceptable, you could use the hook to modify them too. See also\n\
/* Adjust the priority of an insn as you see fit. Returns the new priority. */
DEFHOOK
(adjust_priority,
- "This hook adjusts the integer scheduling priority @var{priority} of\n\
-@var{insn}. It should return the new priority. Increase the priority to\n\
-execute @var{insn} earlier, reduce the priority to execute @var{insn}\n\
+ "This hook adjusts the integer scheduling priority :samp:`{priority}` of\n\
+:samp:`{insn}`. It should return the new priority. Increase the priority to\n\
+execute :samp:`{insn}` earlier, reduce the priority to execute :samp:`{insn}`\n\
later. Do not define this hook if you do not need to adjust the\n\
scheduling priorities of insns.",
int, (rtx_insn *insn, int priority), NULL)
@@ -975,10 +963,10 @@ issue at the same time on the target machine. The default is one.\n\
Although the insn scheduler can define itself the possibility of issue\n\
an insn on the same cycle, the value can serve as an additional\n\
constraint to issue insns on the same simulated processor cycle (see\n\
-hooks @samp{TARGET_SCHED_REORDER} and @samp{TARGET_SCHED_REORDER2}).\n\
+hooks :samp:`TARGET_SCHED_REORDER` and :samp:`TARGET_SCHED_REORDER2`).\n\
This value must be constant over the entire compilation. If you need\n\
it to vary depending on what the instructions are, you must use\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}.",
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`.",
int, (void), NULL)
/* Calculate how much this insn affects how many more insns we
@@ -988,13 +976,13 @@ DEFHOOK
"This hook is executed by the scheduler after it has scheduled an insn\n\
from the ready list. It should return the number of insns which can\n\
still be issued in the current cycle. The default is\n\
-@samp{@w{@var{more} - 1}} for insns other than @code{CLOBBER} and\n\
-@code{USE}, which normally are not counted against the issue rate.\n\
+:samp:`{more} - 1` for insns other than ``CLOBBER`` and\n\
+``USE``, which normally are not counted against the issue rate.\n\
You should define this hook if some insns take more machine resources\n\
than others, so that fewer insns can follow them in the same cycle.\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{insn} is the instruction that\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{insn}` is the instruction that\n\
was scheduled.",
int, (FILE *file, int verbose, rtx_insn *insn, int more), NULL)
@@ -1002,12 +990,12 @@ was scheduled.",
DEFHOOK
(init,
"This hook is executed by the scheduler at the beginning of each block of\n\
-instructions that are to be scheduled. @var{file} is either a null\n\
-pointer, or a stdio stream to write any debug output to. @var{verbose}\n\
-is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{max_ready} is the maximum number of insns in the current scheduling\n\
+instructions that are to be scheduled. :samp:`{file}` is either a null\n\
+pointer, or a stdio stream to write any debug output to. :samp:`{verbose}`\n\
+is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{max_ready}` is the maximum number of insns in the current scheduling\n\
region that can be live at the same time. This can be used to allocate\n\
-scratch space if it is needed, e.g.@: by @samp{TARGET_SCHED_REORDER}.",
+scratch space if it is needed, e.g. by :samp:`TARGET_SCHED_REORDER`.",
void, (FILE *file, int verbose, int max_ready), NULL)
/* Finalize machine-dependent scheduling code. */
@@ -1015,27 +1003,27 @@ DEFHOOK
(finish,
"This hook is executed by the scheduler at the end of each block of\n\
instructions that are to be scheduled. It can be used to perform\n\
-cleanup of any actions done by the other scheduling hooks. @var{file}\n\
+cleanup of any actions done by the other scheduling hooks. :samp:`{file}`\n\
is either a null pointer, or a stdio stream to write any debug output\n\
-to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}.",
+to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Initialize machine-dependent function wide scheduling code. */
DEFHOOK
(init_global,
"This hook is executed by the scheduler after function level initializations.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.\n\
-@var{old_max_uid} is the maximum insn uid when scheduling begins.",
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.\n\
+:samp:`{old_max_uid}` is the maximum insn uid when scheduling begins.",
void, (FILE *file, int verbose, int old_max_uid), NULL)
/* Finalize machine-dependent function wide scheduling code. */
DEFHOOK
(finish_global,
- "This is the cleanup hook corresponding to @code{TARGET_SCHED_INIT_GLOBAL}.\n\
-@var{file} is either a null pointer, or a stdio stream to write any debug output to.\n\
-@var{verbose} is the verbose level provided by @option{-fsched-verbose-@var{n}}.",
+ "This is the cleanup hook corresponding to ``TARGET_SCHED_INIT_GLOBAL``.\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any debug output to.\n\
+:samp:`{verbose}` is the verbose level provided by :option:`-fsched-verbose-n`.",
void, (FILE *file, int verbose), NULL)
/* Reorder insns in a machine-dependent fashion, in two different
@@ -1044,26 +1032,26 @@ DEFHOOK
(reorder,
"This hook is executed by the scheduler after it has scheduled the ready\n\
list, to allow the machine description to reorder it (for example to\n\
-combine two small instructions together on @samp{VLIW} machines).\n\
-@var{file} is either a null pointer, or a stdio stream to write any\n\
-debug output to. @var{verbose} is the verbose level provided by\n\
-@option{-fsched-verbose-@var{n}}. @var{ready} is a pointer to the ready\n\
-list of instructions that are ready to be scheduled. @var{n_readyp} is\n\
+combine two small instructions together on :samp:`VLIW` machines).\n\
+:samp:`{file}` is either a null pointer, or a stdio stream to write any\n\
+debug output to. :samp:`{verbose}` is the verbose level provided by\n\
+:option:`-fsched-verbose-n`. :samp:`{ready}` is a pointer to the ready\n\
+list of instructions that are ready to be scheduled. :samp:`{n_readyp}` is\n\
a pointer to the number of elements in the ready list. The scheduler\n\
reads the ready list in reverse order, starting with\n\
-@var{ready}[@var{*n_readyp} @minus{} 1] and going to @var{ready}[0]. @var{clock}\n\
+:samp:`{ready}` [ :samp:`{*n_readyp}` - 1] and going to :samp:`{ready}` [0]. :samp:`{clock}`\n\
is the timer tick of the scheduler. You may modify the ready list and\n\
the number of ready insns. The return value is the number of insns that\n\
-can issue this cycle; normally this is just @code{issue_rate}. See also\n\
-@samp{TARGET_SCHED_REORDER2}.",
+can issue this cycle; normally this is just ``issue_rate``. See also\n\
+:samp:`TARGET_SCHED_REORDER2`.",
int, (FILE *file, int verbose, rtx_insn **ready, int *n_readyp, int clock), NULL)
DEFHOOK
(reorder2,
- "Like @samp{TARGET_SCHED_REORDER}, but called at a different time. That\n\
+ "Like :samp:`TARGET_SCHED_REORDER`, but called at a different time. That\n\
function is called whenever the scheduler starts a new cycle. This one\n\
is called once per iteration over a cycle, immediately after\n\
-@samp{TARGET_SCHED_VARIABLE_ISSUE}; it can reorder the ready list and\n\
+:samp:`TARGET_SCHED_VARIABLE_ISSUE`; it can reorder the ready list and\n\
return the number of insns to be scheduled in the same cycle. Defining\n\
this hook can be useful if there are frequent situations where\n\
scheduling one insn causes other insns to become ready in the same\n\
@@ -1079,7 +1067,7 @@ DEFHOOK
(macro_fusion_pair_p,
"This hook is used to check whether two insns should be macro fused for\n\
a target microarchitecture. If this hook returns true for the given insn pair\n\
-(@var{prev} and @var{curr}), the scheduler will put them into a sched\n\
+(:samp:`{prev}` and :samp:`{curr}`), the scheduler will put them into a sched\n\
group, and they will not be scheduled apart. The two insns will be either\n\
two SET insns or a compare and a conditional jump and this hook should\n\
validate any dependencies needed to fuse the two insns together.",
@@ -1091,7 +1079,7 @@ validate any dependencies needed to fuse the two insns together.",
DEFHOOK
(dependencies_evaluation_hook,
"This hook is called after evaluation forward dependencies of insns in\n\
-chain given by two parameter values (@var{head} and @var{tail}\n\
+chain given by two parameter values (:samp:`{head}` and :samp:`{tail}`\n\
correspondingly) but before insns scheduling of the insn chain. For\n\
example, it can be used for better insn classification if it requires\n\
analysis of dependencies. This hook can use backward and forward\n\
@@ -1119,7 +1107,7 @@ DEFHOOK
"The hook returns an RTL insn. The automaton state used in the\n\
pipeline hazard recognizer is changed as if the insn were scheduled\n\
when the new simulated processor cycle starts. Usage of the hook may\n\
-simplify the automaton pipeline description for some @acronym{VLIW}\n\
+simplify the automaton pipeline description for some VLIW\n\
processors. If the hook is defined, it is used only for the automaton\n\
based pipeline description. The default is not to change the state\n\
when the new simulated processor cycle starts.",
@@ -1127,13 +1115,13 @@ when the new simulated processor cycle starts.",
DEFHOOK
(init_dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN} but\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_INIT_DFA_PRE_CYCLE_INSN` but\n\
used to initialize data used by the previous hook.",
void, (void), NULL)
DEFHOOK
(dfa_post_cycle_insn,
- "The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+ "The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to changed the state as if the insn were scheduled when the new\n\
simulated processor cycle finishes.",
rtx_insn *, (void), NULL)
@@ -1146,7 +1134,7 @@ simulated processor cycle finishes.",
DEFHOOK
(dfa_pre_advance_cycle,
"The hook to notify target that the current simulated cycle is about to finish.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_PRE_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_PRE_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1154,7 +1142,7 @@ state on a single insn is not enough.",
DEFHOOK
(dfa_post_advance_cycle,
"The hook to notify target that new simulated cycle has just started.\n\
-The hook is analogous to @samp{TARGET_SCHED_DFA_POST_CYCLE_INSN} but used\n\
+The hook is analogous to :samp:`TARGET_SCHED_DFA_POST_CYCLE_INSN` but used\n\
to change the state in more complicated situations - e.g., when advancing\n\
state on a single insn is not enough.",
void, (void), NULL)
@@ -1169,23 +1157,23 @@ state on a single insn is not enough.",
DEFHOOK
(first_cycle_multipass_dfa_lookahead,
"This hook controls better choosing an insn from the ready insn queue\n\
-for the @acronym{DFA}-based insn scheduler. Usually the scheduler\n\
+for the DFA-based insn scheduler. Usually the scheduler\n\
chooses the first insn from the queue. If the hook returns a positive\n\
value, an additional scheduler code tries all permutations of\n\
-@samp{TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()}\n\
+:samp:`TARGET_SCHED_FIRST_CYCLE_MULTIPASS_DFA_LOOKAHEAD ()`\n\
subsequent ready insns to choose an insn whose issue will result in\n\
maximal number of issued insns on the same cycle. For the\n\
-@acronym{VLIW} processor, the code could actually solve the problem of\n\
-packing simple insns into the @acronym{VLIW} insn. Of course, if the\n\
-rules of @acronym{VLIW} packing are described in the automaton.\n\
-\n\
-This code also could be used for superscalar @acronym{RISC}\n\
-processors. Let us consider a superscalar @acronym{RISC} processor\n\
-with 3 pipelines. Some insns can be executed in pipelines @var{A} or\n\
-@var{B}, some insns can be executed only in pipelines @var{B} or\n\
-@var{C}, and one insn can be executed in pipeline @var{B}. The\n\
-processor may issue the 1st insn into @var{A} and the 2nd one into\n\
-@var{B}. In this case, the 3rd insn will wait for freeing @var{B}\n\
+VLIW processor, the code could actually solve the problem of\n\
+packing simple insns into the VLIW insn. Of course, if the\n\
+rules of VLIW packing are described in the automaton.\n\
+\n\
+This code also could be used for superscalar RISC\n\
+processors. Let us consider a superscalar RISC processor\n\
+with 3 pipelines. Some insns can be executed in pipelines :samp:`{A}` or\n\
+:samp:`{B}`, some insns can be executed only in pipelines :samp:`{B}` or\n\
+:samp:`{C}`, and one insn can be executed in pipeline :samp:`{B}`. The\n\
+processor may issue the 1st insn into :samp:`{A}` and the 2nd one into\n\
+:samp:`{B}`. In this case, the 3rd insn will wait for freeing :samp:`{B}`\n\
until the next cycle. If the scheduler issues the 3rd insn the first,\n\
the processor could issue all 3 insns per cycle.\n\
\n\
@@ -1202,16 +1190,15 @@ The default is no multipass scheduling.",
passed as the parameter, the insn will be not chosen to be issued. */
DEFHOOK
(first_cycle_multipass_dfa_lookahead_guard,
- "\n\
-This hook controls what insns from the ready insn queue will be\n\
+ "This hook controls what insns from the ready insn queue will be\n\
considered for the multipass insn scheduling. If the hook returns\n\
-zero for @var{insn}, the insn will be considered in multipass scheduling.\n\
-Positive return values will remove @var{insn} from consideration on\n\
+zero for :samp:`{insn}`, the insn will be considered in multipass scheduling.\n\
+Positive return values will remove :samp:`{insn}` from consideration on\n\
the current round of multipass scheduling.\n\
-Negative return values will remove @var{insn} from consideration for given\n\
+Negative return values will remove :samp:`{insn}` from consideration for given\n\
number of cycles.\n\
Backends should be careful about returning non-zero for highest priority\n\
-instruction at position 0 in the ready list. @var{ready_index} is passed\n\
+instruction at position 0 in the ready list. :samp:`{ready_index}` is passed\n\
to allow backends make correct judgements.\n\
\n\
The default is that any ready insns can be chosen to be issued.",
@@ -1311,14 +1298,14 @@ DEFHOOK
the previous insn has been issued and the current processor cycle. */
DEFHOOK
(dfa_new_cycle,
- "This hook is called by the insn scheduler before issuing @var{insn}\n\
-on cycle @var{clock}. If the hook returns nonzero,\n\
-@var{insn} is not issued on this processor cycle. Instead,\n\
-the processor cycle is advanced. If *@var{sort_p}\n\
+ "This hook is called by the insn scheduler before issuing :samp:`{insn}`\n\
+on cycle :samp:`{clock}`. If the hook returns nonzero,\n\
+:samp:`{insn}` is not issued on this processor cycle. Instead,\n\
+the processor cycle is advanced. If \\* :samp:`{sort_p}`\n\
is zero, the insn ready queue is not sorted on the new cycle\n\
-start as usually. @var{dump} and @var{verbose} specify the file and\n\
+start as usually. :samp:`{dump}` and :samp:`{verbose}` specify the file and\n\
verbosity level to use for debugging output.\n\
-@var{last_clock} and @var{clock} are, respectively, the\n\
+:samp:`{last_clock}` and :samp:`{clock}` are, respectively, the\n\
processor cycle on which the previous insn has been issued,\n\
and the current processor cycle.",
int, (FILE *dump, int verbose, rtx_insn *insn, int last_clock,
@@ -1339,13 +1326,13 @@ DEFHOOK
"This hook is used to define which dependences are considered costly by\n\
the target, so costly that it is not advisable to schedule the insns that\n\
are involved in the dependence too close to one another. The parameters\n\
-to this hook are as follows: The first parameter @var{_dep} is the dependence\n\
-being evaluated. The second parameter @var{cost} is the cost of the\n\
+to this hook are as follows: The first parameter :samp:`{_dep}` is the dependence\n\
+being evaluated. The second parameter :samp:`{cost}` is the cost of the\n\
dependence as estimated by the scheduler, and the third\n\
-parameter @var{distance} is the distance in cycles between the two insns.\n\
-The hook returns @code{true} if considering the distance between the two\n\
+parameter :samp:`{distance}` is the distance in cycles between the two insns.\n\
+The hook returns ``true`` if considering the distance between the two\n\
insns the dependence between them is considered costly by the target,\n\
-and @code{false} otherwise.\n\
+and ``false`` otherwise.\n\
\n\
Defining this hook can be useful in multiple-issue out-of-order machines,\n\
where (a) it's practically hopeless to predict the actual data/resource\n\
@@ -1353,7 +1340,7 @@ delays, however: (b) there's a better chance to predict the actual grouping\n\
that will be formed, and (c) correctly emulating the grouping can be very\n\
important. In such targets one may want to allow issuing dependent insns\n\
closer to one another---i.e., closer than the dependence distance; however,\n\
-not in cases of ``costly dependences'', which this hooks allows to define.",
+not in cases of 'costly dependences', which this hooks allows to define.",
bool, (struct _dep *_dep, int cost, int distance), NULL)
/* The following member value is a pointer to a function called
@@ -1377,27 +1364,27 @@ DEFHOOK
/* Fills the context from the local machine scheduler context. */
DEFHOOK
(init_sched_context,
- "Initialize store pointed to by @var{tc} to hold target scheduling context.\n\
-It @var{clean_p} is true then initialize @var{tc} as if scheduler is at the\n\
-beginning of the block. Otherwise, copy the current context into @var{tc}.",
+ "Initialize store pointed to by :samp:`{tc}` to hold target scheduling context.\n\
+It :samp:`{clean_p}` is true then initialize :samp:`{tc}` as if scheduler is at the\n\
+beginning of the block. Otherwise, copy the current context into :samp:`{tc}`.",
void, (void *tc, bool clean_p), NULL)
/* Sets local machine scheduler context to a saved value. */
DEFHOOK
(set_sched_context,
- "Copy target scheduling context pointed to by @var{tc} to the current context.",
+ "Copy target scheduling context pointed to by :samp:`{tc}` to the current context.",
void, (void *tc), NULL)
/* Clears a scheduler context so it becomes like after init. */
DEFHOOK
(clear_sched_context,
- "Deallocate internal data in target scheduling context pointed to by @var{tc}.",
+ "Deallocate internal data in target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* Frees the scheduler context. */
DEFHOOK
(free_sched_context,
- "Deallocate a store for target scheduling context pointed to by @var{tc}.",
+ "Deallocate a store for target scheduling context pointed to by :samp:`{tc}`.",
void, (void *tc), NULL)
/* The following member value is a pointer to a function called
@@ -1412,13 +1399,13 @@ DEFHOOK
generated one. */
DEFHOOK
(speculate_insn,
- "This hook is called by the insn scheduler when @var{insn} has only\n\
+ "This hook is called by the insn scheduler when :samp:`{insn}` has only\n\
speculative dependencies and therefore can be scheduled speculatively.\n\
-The hook is used to check if the pattern of @var{insn} has a speculative\n\
+The hook is used to check if the pattern of :samp:`{insn}` has a speculative\n\
version and, in case of successful check, to generate that speculative\n\
pattern. The hook should return 1, if the instruction has a speculative form,\n\
-or @minus{}1, if it doesn't. @var{request} describes the type of requested\n\
-speculation. If the return value equals 1 then @var{new_pat} is assigned\n\
+or -1, if it doesn't. :samp:`{request}` describes the type of requested\n\
+speculation. If the return value equals 1 then :samp:`{new_pat}` is assigned\n\
the generated speculative pattern.",
int, (rtx_insn *insn, unsigned int dep_status, rtx *new_pat), NULL)
@@ -1428,8 +1415,8 @@ the generated speculative pattern.",
DEFHOOK
(needs_block_p,
"This hook is called by the insn scheduler during generation of recovery code\n\
-for @var{insn}. It should return @code{true}, if the corresponding check\n\
-instruction should branch to recovery code, or @code{false} otherwise.",
+for :samp:`{insn}`. It should return ``true``, if the corresponding check\n\
+instruction should branch to recovery code, or ``false`` otherwise.",
bool, (unsigned int dep_status), NULL)
/* The following member value is a pointer to a function called
@@ -1442,13 +1429,13 @@ instruction should branch to recovery code, or @code{false} otherwise.",
DEFHOOK
(gen_spec_check,
"This hook is called by the insn scheduler to generate a pattern for recovery\n\
-check instruction. If @var{mutate_p} is zero, then @var{insn} is a\n\
+check instruction. If :samp:`{mutate_p}` is zero, then :samp:`{insn}` is a\n\
speculative instruction for which the check should be generated.\n\
-@var{label} is either a label of a basic block, where recovery code should\n\
+:samp:`{label}` is either a label of a basic block, where recovery code should\n\
be emitted, or a null pointer, when requested check doesn't branch to\n\
-recovery code (a simple check). If @var{mutate_p} is nonzero, then\n\
+recovery code (a simple check). If :samp:`{mutate_p}` is nonzero, then\n\
a pattern for a branchy check corresponding to a simple check denoted by\n\
-@var{insn} should be generated. In this case @var{label} can't be null.",
+:samp:`{insn}` should be generated. In this case :samp:`{label}` can't be null.",
rtx, (rtx_insn *insn, rtx_insn *label, unsigned int ds), NULL)
/* The following member value is a pointer to a function that provides
@@ -1458,7 +1445,7 @@ DEFHOOK
(set_sched_flags,
"This hook is used by the insn scheduler to find out what features should be\n\
enabled/used.\n\
-The structure *@var{spec_info} should be filled in by the target.\n\
+The structure \\* :samp:`{spec_info}` should be filled in by the target.\n\
The structure describes speculation types that can be used in the scheduler.",
void, (struct spec_info_def *spec_info), NULL)
@@ -1475,10 +1462,10 @@ DEFHOOK_UNDOC
DEFHOOK
(can_speculate_insn,
"Some instructions should never be speculated by the schedulers, usually\n\
- because the instruction is too expensive to get this wrong. Often such\n\
- instructions have long latency, and often they are not fully modeled in the\n\
- pipeline descriptions. This hook should return @code{false} if @var{insn}\n\
- should not be speculated.",
+because the instruction is too expensive to get this wrong. Often such\n\
+instructions have long latency, and often they are not fully modeled in the\n\
+pipeline descriptions. This hook should return ``false`` if :samp:`{insn}`\n\
+should not be speculated.",
bool, (rtx_insn *insn), hook_bool_rtx_insn_true)
DEFHOOK_UNDOC
@@ -1496,7 +1483,7 @@ DEFHOOK
"This hook is called by the swing modulo scheduler to calculate a\n\
resource-based lower bound which is based on the resources available in\n\
the machine and the resources required by each instruction. The target\n\
-backend can use @var{g} to calculate such bound. A very simple lower\n\
+backend can use :samp:`{g}` to calculate such bound. A very simple lower\n\
bound will be used in case this hook is not implemented: the total number\n\
of instructions divided by the issue rate.",
int, (struct ddg *g), NULL)
@@ -1506,7 +1493,7 @@ of instructions divided by the issue rate.",
parameters. */
DEFHOOK
(dispatch_do,
-"This hook is called by Haifa Scheduler. It performs the operation specified\n\
+ "This hook is called by Haifa Scheduler. It performs the operation specified\n\
in its second parameter.",
void, (rtx_insn *insn, int x),
hook_void_rtx_insn_int)
@@ -1516,14 +1503,14 @@ hook_void_rtx_insn_int)
as the second parameter is true. */
DEFHOOK
(dispatch,
-"This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
+ "This hook is called by Haifa Scheduler. It returns true if dispatch scheduling\n\
is supported in hardware and the condition specified in the parameter is true.",
bool, (rtx_insn *insn, int x),
hook_bool_rtx_insn_int_false)
DEFHOOKPOD
(exposed_pipeline,
-"True if the processor has an exposed pipeline, which means that not just\n\
+ "True if the processor has an exposed pipeline, which means that not just\n\
the order of instructions is important for correctness when scheduling, but\n\
also the latencies of operations.",
bool, false)
@@ -1533,7 +1520,7 @@ bool, false)
statements of the given type. By default 1 is used. */
DEFHOOK
(reassociation_width,
-"This hook is called by tree reassociator to determine a level of\n\
+ "This hook is called by tree reassociator to determine a level of\n\
parallelism required in output calculations chain.",
int, (unsigned int opc, machine_mode mode),
hook_int_uint_mode_1)
@@ -1542,39 +1529,39 @@ hook_int_uint_mode_1)
fusion of each instruction via pointer parameters. */
DEFHOOK
(fusion_priority,
-"This hook is called by scheduling fusion pass. It calculates fusion\n\
+ "This hook is called by scheduling fusion pass. It calculates fusion\n\
priorities for each instruction passed in by parameter. The priorities\n\
are returned via pointer parameters.\n\
\n\
-@var{insn} is the instruction whose priorities need to be calculated.\n\
-@var{max_pri} is the maximum priority can be returned in any cases.\n\
-@var{fusion_pri} is the pointer parameter through which @var{insn}'s\n\
+:samp:`{insn}` is the instruction whose priorities need to be calculated.\n\
+:samp:`{max_pri}` is the maximum priority can be returned in any cases.\n\
+:samp:`{fusion_pri}` is the pointer parameter through which :samp:`{insn}` 's\n\
fusion priority should be calculated and returned.\n\
-@var{pri} is the pointer parameter through which @var{insn}'s priority\n\
+:samp:`{pri}` is the pointer parameter through which :samp:`{insn}` 's priority\n\
should be calculated and returned.\n\
\n\
-Same @var{fusion_pri} should be returned for instructions which should\n\
-be scheduled together. Different @var{pri} should be returned for\n\
-instructions with same @var{fusion_pri}. @var{fusion_pri} is the major\n\
-sort key, @var{pri} is the minor sort key. All instructions will be\n\
+Same :samp:`{fusion_pri}` should be returned for instructions which should\n\
+be scheduled together. Different :samp:`{pri}` should be returned for\n\
+instructions with same :samp:`{fusion_pri}`. :samp:`{fusion_pri}` is the major\n\
+sort key, :samp:`{pri}` is the minor sort key. All instructions will be\n\
scheduled according to the two priorities. All priorities calculated\n\
-should be between 0 (exclusive) and @var{max_pri} (inclusive). To avoid\n\
-false dependencies, @var{fusion_pri} of instructions which need to be\n\
-scheduled together should be smaller than @var{fusion_pri} of irrelevant\n\
+should be between 0 (exclusive) and :samp:`{max_pri}` (inclusive). To avoid\n\
+false dependencies, :samp:`{fusion_pri}` of instructions which need to be\n\
+scheduled together should be smaller than :samp:`{fusion_pri}` of irrelevant\n\
instructions.\n\
\n\
Given below example:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4]\n\
- add r4, r4, r10\n\
- ldr r15, [r2, 8]\n\
- sub r5, r5, r15\n\
- ldr r11, [r1, 0]\n\
- add r4, r4, r11\n\
- ldr r16, [r2, 12]\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4]\n\
+ add r4, r4, r10\n\
+ ldr r15, [r2, 8]\n\
+ sub r5, r5, r15\n\
+ ldr r11, [r1, 0]\n\
+ add r4, r4, r11\n\
+ ldr r16, [r2, 12]\n\
+ sub r5, r5, r16\n\
\n\
On targets like ARM/AArch64, the two pairs of consecutive loads should be\n\
merged. Since peephole2 pass can't help in this case unless consecutive\n\
@@ -1582,31 +1569,31 @@ loads are actually next to each other in instruction flow. That's where\n\
this scheduling fusion pass works. This hook calculates priority for each\n\
instruction based on its fustion type, like:\n\
\n\
-@smallexample\n\
- ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
- add r4, r4, r10 ; fusion_pri=100, pri=100\n\
- ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
- sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
- ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
- add r4, r4, r11 ; fusion_pri=100, pri=100\n\
- ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
- sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r10, [r1, 4] ; fusion_pri=99, pri=96\n\
+ add r4, r4, r10 ; fusion_pri=100, pri=100\n\
+ ldr r15, [r2, 8] ; fusion_pri=98, pri=92\n\
+ sub r5, r5, r15 ; fusion_pri=100, pri=100\n\
+ ldr r11, [r1, 0] ; fusion_pri=99, pri=100\n\
+ add r4, r4, r11 ; fusion_pri=100, pri=100\n\
+ ldr r16, [r2, 12] ; fusion_pri=98, pri=88\n\
+ sub r5, r5, r16 ; fusion_pri=100, pri=100\n\
\n\
Scheduling fusion pass then sorts all ready to issue instructions according\n\
to the priorities. As a result, instructions of same fusion type will be\n\
pushed together in instruction flow, like:\n\
\n\
-@smallexample\n\
- ldr r11, [r1, 0]\n\
- ldr r10, [r1, 4]\n\
- ldr r15, [r2, 8]\n\
- ldr r16, [r2, 12]\n\
- add r4, r4, r10\n\
- sub r5, r5, r15\n\
- add r4, r4, r11\n\
- sub r5, r5, r16\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ ldr r11, [r1, 0]\n\
+ ldr r10, [r1, 4]\n\
+ ldr r15, [r2, 8]\n\
+ ldr r16, [r2, 12]\n\
+ add r4, r4, r10\n\
+ sub r5, r5, r15\n\
+ add r4, r4, r11\n\
+ sub r5, r5, r16\n\
\n\
Now peephole2 pass can simply merge the two pairs of loads.\n\
\n\
@@ -1626,25 +1613,25 @@ HOOK_VECTOR (TARGET_SIMD_CLONE, simd_clone)
DEFHOOK
(compute_vecsize_and_simdlen,
-"This hook should set @var{vecsize_mangle}, @var{vecsize_int}, @var{vecsize_float}\n\
-fields in @var{simd_clone} structure pointed by @var{clone_info} argument and also\n\
-@var{simdlen} field if it was previously 0.\n\
-@var{vecsize_mangle} is a marker for the backend only. @var{vecsize_int} and\n\
-@var{vecsize_float} should be left zero on targets where the number of lanes is\n\
-not determined by the bitsize (in which case @var{simdlen} is always used).\n\
+ "This hook should set :samp:`{vecsize_mangle}`, :samp:`{vecsize_int}`, :samp:`{vecsize_float}`\n\
+fields in :samp:`{simd_clone}` structure pointed by :samp:`{clone_info}` argument and also\n\
+:samp:`{simdlen}` field if it was previously 0.\n\
+:samp:`{vecsize_mangle}` is a marker for the backend only. :samp:`{vecsize_int}` and\n\
+:samp:`{vecsize_float}` should be left zero on targets where the number of lanes is\n\
+not determined by the bitsize (in which case :samp:`{simdlen}` is always used).\n\
The hook should return 0 if SIMD clones shouldn't be emitted,\n\
-or number of @var{vecsize_mangle} variants that should be emitted.",
+or number of :samp:`{vecsize_mangle}` variants that should be emitted.",
int, (struct cgraph_node *, struct cgraph_simd_clone *, tree, int), NULL)
DEFHOOK
(adjust,
-"This hook should add implicit @code{attribute(target(\"...\"))} attribute\n\
-to SIMD clone @var{node} if needed.",
+ "This hook should add implicit ``attribute(target(\"...\"))`` attribute\n\
+to SIMD clone :samp:`{node}` if needed.",
void, (struct cgraph_node *), NULL)
DEFHOOK
(usable,
-"This hook should return -1 if SIMD clone @var{node} shouldn't be used\n\
+ "This hook should return -1 if SIMD clone :samp:`{node}` shouldn't be used\n\
in vectorized loops in current function, or non-negative number if it is\n\
usable. In that case, the smaller the number is, the more desirable it is\n\
to use it.",
@@ -1659,7 +1646,7 @@ HOOK_VECTOR (TARGET_SIMT, simt)
DEFHOOK
(vf,
-"Return number of threads in SIMT thread group on the target.",
+ "Return number of threads in SIMT thread group on the target.",
int, (void), NULL)
HOOK_VECTOR_END (simt)
@@ -1671,7 +1658,7 @@ HOOK_VECTOR (TARGET_OMP, omp)
DEFHOOK
(device_kind_arch_isa,
-"Return 1 if @var{trait} @var{name} is present in the OpenMP context's\n\
+ "Return 1 if :samp:`{trait}` :samp:`{name}` is present in the OpenMP context's\n\
device trait set, return 0 if not present in any OpenMP context in the\n\
whole translation unit, or -1 if not present in the current OpenMP context\n\
but might be present in another OpenMP context in the same TU.",
@@ -1686,9 +1673,9 @@ HOOK_VECTOR (TARGET_GOACC, goacc)
DEFHOOK
(validate_dims,
-"This hook should check the launch dimensions provided for an OpenACC\n\
+ "This hook should check the launch dimensions provided for an OpenACC\n\
compute region, or routine. Defaulted values are represented as -1\n\
-and non-constant values as 0. The @var{fn_level} is negative for the\n\
+and non-constant values as 0. The :samp:`{fn_level}` is negative for the\n\
function corresponding to the compute region. For a routine it is the\n\
outermost level at which partitioned execution may be spawned. The hook\n\
should verify non-default values. If DECL is NULL, global defaults\n\
@@ -1701,14 +1688,14 @@ default_goacc_validate_dims)
DEFHOOK
(dim_limit,
-"This hook should return the maximum size of a particular dimension,\n\
+ "This hook should return the maximum size of a particular dimension,\n\
or zero if unbounded.",
int, (int axis),
default_goacc_dim_limit)
DEFHOOK
(fork_join,
-"This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
+ "This hook can be used to convert IFN_GOACC_FORK and IFN_GOACC_JOIN\n\
function calls to target-specific gimple, or indicate whether they\n\
should be retained. It is executed during the oacc_device_lower pass.\n\
It should return true, if the call should be retained. It should\n\
@@ -1720,10 +1707,10 @@ default_goacc_fork_join)
DEFHOOK
(reduction,
-"This hook is used by the oacc_transform pass to expand calls to the\n\
-@var{GOACC_REDUCTION} internal function, into a sequence of gimple\n\
-instructions. @var{call} is gimple statement containing the call to\n\
-the function. This hook removes statement @var{call} after the\n\
+ "This hook is used by the oacc_transform pass to expand calls to the\n\
+:samp:`{GOACC_REDUCTION}` internal function, into a sequence of gimple\n\
+instructions. :samp:`{call}` is gimple statement containing the call to\n\
+the function. This hook removes statement :samp:`{call}` after the\n\
expanded sequence has been inserted. This hook is also responsible\n\
for allocating any storage for reductions when necessary.",
void, (gcall *call),
@@ -1731,14 +1718,14 @@ default_goacc_reduction)
DEFHOOK
(adjust_private_decl,
-"This hook, if defined, is used by accelerator target back-ends to adjust\n\
+ "This hook, if defined, is used by accelerator target back-ends to adjust\n\
OpenACC variable declarations that should be made private to the given\n\
-parallelism level (i.e. @code{GOMP_DIM_GANG}, @code{GOMP_DIM_WORKER} or\n\
-@code{GOMP_DIM_VECTOR}). A typical use for this hook is to force variable\n\
-declarations at the @code{gang} level to reside in GPU shared memory.\n\
-@var{loc} may be used for diagnostic purposes.\n\
+parallelism level (i.e. ``GOMP_DIM_GANG``, ``GOMP_DIM_WORKER`` or\n\
+``GOMP_DIM_VECTOR``). A typical use for this hook is to force variable\n\
+declarations at the ``gang`` level to reside in GPU shared memory.\n\
+:samp:`{loc}` may be used for diagnostic purposes.\n\
\n\
-You may also use the @code{TARGET_GOACC_EXPAND_VAR_DECL} hook if the\n\
+You may also use the ``TARGET_GOACC_EXPAND_VAR_DECL`` hook if the\n\
adjusted variable declaration needs to be expanded to RTL in a non-standard\n\
way.",
tree, (location_t loc, tree var, int level),
@@ -1746,22 +1733,22 @@ NULL)
DEFHOOK
(expand_var_decl,
-"This hook, if defined, is used by accelerator target back-ends to expand\n\
-specially handled kinds of @code{VAR_DECL} expressions. A particular use is\n\
+ "This hook, if defined, is used by accelerator target back-ends to expand\n\
+specially handled kinds of ``VAR_DECL`` expressions. A particular use is\n\
to place variables with specific attributes inside special accelarator\n\
-memories. A return value of @code{NULL} indicates that the target does not\n\
-handle this @code{VAR_DECL}, and normal RTL expanding is resumed.\n\
+memories. A return value of ``NULL`` indicates that the target does not\n\
+handle this ``VAR_DECL``, and normal RTL expanding is resumed.\n\
\n\
Only define this hook if your accelerator target needs to expand certain\n\
-@code{VAR_DECL} nodes in a way that differs from the default. You can also adjust\n\
+``VAR_DECL`` nodes in a way that differs from the default. You can also adjust\n\
private variables at OpenACC device-lowering time using the\n\
-@code{TARGET_GOACC_ADJUST_PRIVATE_DECL} target hook.",
+``TARGET_GOACC_ADJUST_PRIVATE_DECL`` target hook.",
rtx, (tree var),
NULL)
DEFHOOK
(create_worker_broadcast_record,
-"Create a record used to propagate local-variable state from an active\n\
+ "Create a record used to propagate local-variable state from an active\n\
worker to other workers. A possible implementation might adjust the type\n\
of REC to place the new variable in shared GPU memory.\n\
\n\
@@ -1772,7 +1759,7 @@ NULL)
DEFHOOK
(shared_mem_layout,
-"Lay out a fixed shared-memory region on the target. The LO and HI\n\
+ "Lay out a fixed shared-memory region on the target. The LO and HI\n\
arguments should be set to a range of addresses that can be used for worker\n\
broadcasting. The dimensions, reduction size and gang-private size\n\
arguments are for the current offload region.",
@@ -1792,32 +1779,32 @@ HOOK_VECTOR (TARGET_VECTORIZE, vectorize)
function. */
DEFHOOK
(builtin_mask_for_load,
- "This hook should return the DECL of a function @var{f} that given an\n\
-address @var{addr} as an argument returns a mask @var{m} that can be\n\
+ "This hook should return the DECL of a function :samp:`{f}` that given an\n\
+address :samp:`{addr}` as an argument returns a mask :samp:`{m}` that can be\n\
used to extract from two vectors the relevant data that resides in\n\
-@var{addr} in case @var{addr} is not properly aligned.\n\
+:samp:`{addr}` in case :samp:`{addr}` is not properly aligned.\n\
\n\
The autovectorizer, when vectorizing a load operation from an address\n\
-@var{addr} that may be unaligned, will generate two vector loads from\n\
-the two aligned addresses around @var{addr}. It then generates a\n\
-@code{REALIGN_LOAD} operation to extract the relevant data from the\n\
-two loaded vectors. The first two arguments to @code{REALIGN_LOAD},\n\
-@var{v1} and @var{v2}, are the two vectors, each of size @var{VS}, and\n\
-the third argument, @var{OFF}, defines how the data will be extracted\n\
-from these two vectors: if @var{OFF} is 0, then the returned vector is\n\
-@var{v2}; otherwise, the returned vector is composed from the last\n\
-@var{VS}-@var{OFF} elements of @var{v1} concatenated to the first\n\
-@var{OFF} elements of @var{v2}.\n\
+:samp:`{addr}` that may be unaligned, will generate two vector loads from\n\
+the two aligned addresses around :samp:`{addr}`. It then generates a\n\
+``REALIGN_LOAD`` operation to extract the relevant data from the\n\
+two loaded vectors. The first two arguments to ``REALIGN_LOAD``,\n\
+:samp:`{v1}` and :samp:`{v2}`, are the two vectors, each of size :samp:`{VS}`, and\n\
+the third argument, :samp:`{OFF}`, defines how the data will be extracted\n\
+from these two vectors: if :samp:`{OFF}` is 0, then the returned vector is\n\
+:samp:`{v2}` ; otherwise, the returned vector is composed from the last\n\
+:samp:`{VS}` - :samp:`{OFF}` elements of :samp:`{v1}` concatenated to the first\n\
+:samp:`{OFF}` elements of :samp:`{v2}`.\n\
\n\
If this hook is defined, the autovectorizer will generate a call\n\
-to @var{f} (using the DECL tree that this hook returns) and will\n\
-use the return value of @var{f} as the argument @var{OFF} to\n\
-@code{REALIGN_LOAD}. Therefore, the mask @var{m} returned by @var{f}\n\
-should comply with the semantics expected by @code{REALIGN_LOAD}\n\
+to :samp:`{f}` (using the DECL tree that this hook returns) and will\n\
+use the return value of :samp:`{f}` as the argument :samp:`{OFF}` to\n\
+``REALIGN_LOAD``. Therefore, the mask :samp:`{m}` returned by :samp:`{f}`\n\
+should comply with the semantics expected by ``REALIGN_LOAD``\n\
described above.\n\
-If this hook is not defined, then @var{addr} will be used as\n\
-the argument @var{OFF} to @code{REALIGN_LOAD}, in which case the low\n\
-log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
+If this hook is not defined, then :samp:`{addr}` will be used as\n\
+the argument :samp:`{OFF}` to ``REALIGN_LOAD``, in which case the low\n\
+log2(:samp:`{VS}`) - 1 bits of :samp:`{addr}` will be considered.",
tree, (void), NULL)
/* Returns a built-in function that realizes the vectorized version of
@@ -1825,10 +1812,10 @@ log2(@var{VS}) @minus{} 1 bits of @var{addr} will be considered.",
DEFHOOK
(builtin_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of the function with the @code{combined_fn} code\n\
-@var{code} or @code{NULL_TREE} if such a function is not available.\n\
+vectorized variant of the function with the ``combined_fn`` code\n\
+:samp:`{code}` or ``NULL_TREE`` if such a function is not available.\n\
The return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (unsigned code, tree vec_type_out, tree vec_type_in),
default_builtin_vectorized_function)
@@ -1837,9 +1824,9 @@ The return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_md_vectorized_function,
"This hook should return the decl of a function that implements the\n\
-vectorized variant of target built-in function @code{fndecl}. The\n\
+vectorized variant of target built-in function ``fndecl``. The\n\
return type of the vectorized function shall be of vector type\n\
-@var{vec_type_out} and the argument types should be @var{vec_type_in}.",
+:samp:`{vec_type_out}` and the argument types should be :samp:`{vec_type_in}`.",
tree, (tree fndecl, tree vec_type_out, tree vec_type_in),
default_builtin_md_vectorized_function)
@@ -1849,21 +1836,21 @@ return type of the vectorized function shall be of vector type\n\
DEFHOOK
(builtin_vectorization_cost,
"Returns cost of different scalar or vector statements for vectorization cost model.\n\
-For vector memory operations the cost may depend on type (@var{vectype}) and\n\
-misalignment value (@var{misalign}).",
+For vector memory operations the cost may depend on type (:samp:`{vectype}`) and\n\
+misalignment value (:samp:`{misalign}`).",
int, (enum vect_cost_for_stmt type_of_cost, tree vectype, int misalign),
default_builtin_vectorization_cost)
DEFHOOK
(preferred_vector_alignment,
"This hook returns the preferred alignment in bits for accesses to\n\
-vectors of type @var{type} in vectorized code. This might be less than\n\
+vectors of type :samp:`{type}` in vectorized code. This might be less than\n\
or greater than the ABI-defined value returned by\n\
-@code{TARGET_VECTOR_ALIGNMENT}. It can be equal to the alignment of\n\
+``TARGET_VECTOR_ALIGNMENT``. It can be equal to the alignment of\n\
a single element, in which case the vectorizer will not try to optimize\n\
for alignment.\n\
\n\
-The default hook returns @code{TYPE_ALIGN (@var{type})}, which is\n\
+The default hook returns ``TYPE_ALIGN (type)``, which is\n\
correct for most targets.",
poly_uint64, (const_tree type),
default_preferred_vector_alignment)
@@ -1873,32 +1860,33 @@ correct for most targets.",
DEFHOOK
(vector_alignment_reachable,
"Return true if vector alignment is reachable (by peeling N iterations)\n\
-for the given scalar type @var{type}. @var{is_packed} is false if the scalar\n\
-access using @var{type} is known to be naturally aligned.",
+for the given scalar type :samp:`{type}`. :samp:`{is_packed}` is false if the scalar\n\
+access using :samp:`{type}` is known to be naturally aligned.",
bool, (const_tree type, bool is_packed),
default_builtin_vector_alignment_reachable)
DEFHOOK
(vec_perm_const,
"This hook is used to test whether the target can permute up to two\n\
-vectors of mode @var{op_mode} using the permutation vector @code{sel},\n\
-producing a vector of mode @var{mode}. The hook is also used to emit such\n\
+vectors of mode :samp:`{op_mode}` using the permutation vector ``sel``,\n\
+producing a vector of mode :samp:`{mode}`. The hook is also used to emit such\n\
a permutation.\n\
\n\
When the hook is being used to test whether the target supports a permutation,\n\
-@var{in0}, @var{in1}, and @var{out} are all null. When the hook is being used\n\
-to emit a permutation, @var{in0} and @var{in1} are the source vectors of mode\n\
-@var{op_mode} and @var{out} is the destination vector of mode @var{mode}.\n\
-@var{in1} is the same as @var{in0} if @var{sel} describes a permutation on one\n\
+:samp:`{in0}`, :samp:`{in1}`, and :samp:`{out}` are all null. When the hook is being used\n\
+to emit a permutation, :samp:`{in0}` and :samp:`{in1}` are the source vectors of mode\n\
+:samp:`{op_mode}` and :samp:`{out}` is the destination vector of mode :samp:`{mode}`.\n\
+:samp:`{in1}` is the same as :samp:`{in0}` if :samp:`{sel}` describes a permutation on one\n\
vector instead of two.\n\
\n\
Return true if the operation is possible, emitting instructions for it\n\
if rtxes are provided.\n\
\n\
-@cindex @code{vec_perm@var{m}} instruction pattern\n\
+.. index:: vec_permm instruction pattern\n\
+\n\
If the hook returns false for a mode with multibyte elements, GCC will\n\
try the equivalent byte operation. If that also fails, it will try forcing\n\
-the selector into a register and using the @var{vec_perm@var{mode}}\n\
+the selector into a register and using the :samp:`{vec_perm {mode} }`\n\
instruction pattern. There is no need for the hook to handle these two\n\
implementation approaches itself.",
bool, (machine_mode mode, machine_mode op_mode, rtx output, rtx in0, rtx in1,
@@ -1911,9 +1899,9 @@ implementation approaches itself.",
DEFHOOK
(support_vector_misalignment,
"This hook should return true if the target supports misaligned vector\n\
-store/load of a specific factor denoted in the @var{misalignment}\n\
-parameter. The vector store/load should be of machine mode @var{mode} and\n\
-the elements in the vectors should be of type @var{type}. @var{is_packed}\n\
+store/load of a specific factor denoted in the :samp:`{misalignment}`\n\
+parameter. The vector store/load should be of machine mode :samp:`{mode}` and\n\
+the elements in the vectors should be of type :samp:`{type}`. :samp:`{is_packed}`\n\
parameter is true if the memory access is defined in a packed struct.",
bool,
(machine_mode mode, const_tree type, int misalignment, bool is_packed),
@@ -1924,9 +1912,9 @@ parameter is true if the memory access is defined in a packed struct.",
DEFHOOK
(preferred_simd_mode,
"This hook should return the preferred mode for vectorizing scalar\n\
-mode @var{mode}. The default is\n\
-equal to @code{word_mode}, because the vectorizer can do some\n\
-transformations even in absence of specialized @acronym{SIMD} hardware.",
+mode :samp:`{mode}`. The default is\n\
+equal to ``word_mode``, because the vectorizer can do some\n\
+transformations even in absence of specialized SIMD hardware.",
machine_mode,
(scalar_mode mode),
default_preferred_simd_mode)
@@ -1935,9 +1923,9 @@ transformations even in absence of specialized @acronym{SIMD} hardware.",
DEFHOOK
(split_reduction,
"This hook should return the preferred mode to split the final reduction\n\
-step on @var{mode} to. The reduction is then carried out reducing upper\n\
+step on :samp:`{mode}` to. The reduction is then carried out reducing upper\n\
against lower halves of vectors recursively until the specified mode is\n\
-reached. The default is @var{mode} which means no splitting.",
+reached. The default is :samp:`{mode}` which means no splitting.",
machine_mode,
(machine_mode),
default_split_reduction)
@@ -1946,32 +1934,32 @@ reached. The default is @var{mode} which means no splitting.",
after processing the preferred one derived from preferred_simd_mode. */
DEFHOOK
(autovectorize_vector_modes,
- "If using the mode returned by @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE}\n\
+ "If using the mode returned by ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE``\n\
is not the only approach worth considering, this hook should add one mode to\n\
-@var{modes} for each useful alternative approach. These modes are then\n\
-passed to @code{TARGET_VECTORIZE_RELATED_MODE} to obtain the vector mode\n\
+:samp:`{modes}` for each useful alternative approach. These modes are then\n\
+passed to ``TARGET_VECTORIZE_RELATED_MODE`` to obtain the vector mode\n\
for a given element mode.\n\
\n\
-The modes returned in @var{modes} should use the smallest element mode\n\
+The modes returned in :samp:`{modes}` should use the smallest element mode\n\
possible for the vectorization approach that they represent, preferring\n\
integer modes over floating-poing modes in the event of a tie. The first\n\
-mode should be the @code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} for its\n\
+mode should be the ``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` for its\n\
element mode.\n\
\n\
-If @var{all} is true, add suitable vector modes even when they are generally\n\
+If :samp:`{all}` is true, add suitable vector modes even when they are generally\n\
not expected to be worthwhile.\n\
\n\
The hook returns a bitmask of flags that control how the modes in\n\
-@var{modes} are used. The flags are:\n\
-@table @code\n\
-@item VECT_COMPARE_COSTS\n\
-Tells the loop vectorizer to try all the provided modes and pick the one\n\
-with the lowest cost. By default the vectorizer will choose the first\n\
-mode that works.\n\
-@end table\n\
+:samp:`{modes}` are used. The flags are:\n\
+\n\
+.. envvar:: VECT_COMPARE_COSTS\n\
+\n\
+ Tells the loop vectorizer to try all the provided modes and pick the one\n\
+ with the lowest cost. By default the vectorizer will choose the first\n\
+ mode that works.\n\
\n\
The hook does not need to do anything if the vector returned by\n\
-@code{TARGET_VECTORIZE_PREFERRED_SIMD_MODE} is the only one relevant\n\
+``TARGET_VECTORIZE_PREFERRED_SIMD_MODE`` is the only one relevant\n\
for autovectorization. The default implementation adds no modes and\n\
returns 0.",
unsigned int,
@@ -1980,27 +1968,27 @@ returns 0.",
DEFHOOK
(related_mode,
- "If a piece of code is using vector mode @var{vector_mode} and also wants\n\
-to operate on elements of mode @var{element_mode}, return the vector mode\n\
-it should use for those elements. If @var{nunits} is nonzero, ensure that\n\
-the mode has exactly @var{nunits} elements, otherwise pick whichever vector\n\
-size pairs the most naturally with @var{vector_mode}. Return an empty\n\
-@code{opt_machine_mode} if there is no supported vector mode with the\n\
+ "If a piece of code is using vector mode :samp:`{vector_mode}` and also wants\n\
+to operate on elements of mode :samp:`{element_mode}`, return the vector mode\n\
+it should use for those elements. If :samp:`{nunits}` is nonzero, ensure that\n\
+the mode has exactly :samp:`{nunits}` elements, otherwise pick whichever vector\n\
+size pairs the most naturally with :samp:`{vector_mode}`. Return an empty\n\
+``opt_machine_mode`` if there is no supported vector mode with the\n\
required properties.\n\
\n\
-There is no prescribed way of handling the case in which @var{nunits}\n\
+There is no prescribed way of handling the case in which :samp:`{nunits}`\n\
is zero. One common choice is to pick a vector mode with the same size\n\
-as @var{vector_mode}; this is the natural choice if the target has a\n\
+as :samp:`{vector_mode}` ; this is the natural choice if the target has a\n\
fixed vector size. Another option is to choose a vector mode with the\n\
-same number of elements as @var{vector_mode}; this is the natural choice\n\
+same number of elements as :samp:`{vector_mode}` ; this is the natural choice\n\
if the target has a fixed number of elements. Alternatively, the hook\n\
might choose a middle ground, such as trying to keep the number of\n\
elements as similar as possible while applying maximum and minimum\n\
vector sizes.\n\
\n\
-The default implementation uses @code{mode_for_vector} to find the\n\
-requested mode, returning a mode with the same size as @var{vector_mode}\n\
-when @var{nunits} is zero. This is the correct behavior for most targets.",
+The default implementation uses ``mode_for_vector`` to find the\n\
+requested mode, returning a mode with the same size as :samp:`{vector_mode}`\n\
+when :samp:`{nunits}` is zero. This is the correct behavior for most targets.",
opt_machine_mode,
(machine_mode vector_mode, scalar_mode element_mode, poly_uint64 nunits),
default_vectorize_related_mode)
@@ -2009,14 +1997,14 @@ when @var{nunits} is zero. This is the correct behavior for most targets.",
DEFHOOK
(get_mask_mode,
"Return the mode to use for a vector mask that holds one boolean\n\
-result for each element of vector mode @var{mode}. The returned mask mode\n\
-can be a vector of integers (class @code{MODE_VECTOR_INT}), a vector of\n\
-booleans (class @code{MODE_VECTOR_BOOL}) or a scalar integer (class\n\
-@code{MODE_INT}). Return an empty @code{opt_machine_mode} if no such\n\
+result for each element of vector mode :samp:`{mode}`. The returned mask mode\n\
+can be a vector of integers (class ``MODE_VECTOR_INT``), a vector of\n\
+booleans (class ``MODE_VECTOR_BOOL``) or a scalar integer (class\n\
+``MODE_INT``). Return an empty ``opt_machine_mode`` if no such\n\
mask mode exists.\n\
\n\
-The default implementation returns a @code{MODE_VECTOR_INT} with the\n\
-same size and number of elements as @var{mode}, if such a mode exists.",
+The default implementation returns a ``MODE_VECTOR_INT`` with the\n\
+same size and number of elements as :samp:`{mode}`, if such a mode exists.",
opt_machine_mode,
(machine_mode mode),
default_get_mask_mode)
@@ -2025,8 +2013,8 @@ same size and number of elements as @var{mode}, if such a mode exists.",
mask is all zeros. */
DEFHOOK
(empty_mask_is_expensive,
- "This hook returns true if masked internal function @var{ifn} (really of\n\
-type @code{internal_fn}) should be considered expensive when the mask is\n\
+ "This hook returns true if masked internal function :samp:`{ifn}` (really of\n\
+type ``internal_fn``) should be considered expensive when the mask is\n\
all zeros. GCC can then try to branch around the instruction instead.",
bool,
(unsigned ifn),
@@ -2035,10 +2023,10 @@ all zeros. GCC can then try to branch around the instruction instead.",
/* Target builtin that implements vector gather operation. */
DEFHOOK
(builtin_gather,
- "Target builtin that implements vector gather operation. @var{mem_vectype}\n\
-is the vector type of the load and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize gather\n\
+ "Target builtin that implements vector gather operation. :samp:`{mem_vectype}`\n\
+is the vector type of the load and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize gather\n\
loads.",
tree,
(const_tree mem_vectype, const_tree index_type, int scale),
@@ -2047,10 +2035,10 @@ loads.",
/* Target builtin that implements vector scatter operation. */
DEFHOOK
(builtin_scatter,
-"Target builtin that implements vector scatter operation. @var{vectype}\n\
-is the vector type of the store and @var{index_type} is scalar type of\n\
-the index, scaled by @var{scale}.\n\
-The default is @code{NULL_TREE} which means to not vectorize scatter\n\
+ "Target builtin that implements vector scatter operation. :samp:`{vectype}`\n\
+is the vector type of the store and :samp:`{index_type}` is scalar type of\n\
+the index, scaled by :samp:`{scale}`.\n\
+The default is ``NULL_TREE`` which means to not vectorize scatter\n\
stores.",
tree,
(const_tree vectype, const_tree index_type, int scale),
@@ -2062,9 +2050,9 @@ DEFHOOK
"This hook should initialize target-specific data structures in preparation\n\
for modeling the costs of vectorizing a loop or basic block. The default\n\
allocates three unsigned integers for accumulating costs for the prologue,\n\
-body, and epilogue of the loop or basic block. If @var{loop_info} is\n\
+body, and epilogue of the loop or basic block. If :samp:`{loop_info}` is\n\
non-NULL, it identifies the loop being vectorized; otherwise a single block\n\
-is being vectorized. If @var{costing_for_scalar} is true, it indicates the\n\
+is being vectorized. If :samp:`{costing_for_scalar}` is true, it indicates the\n\
current cost model is for the scalar version of a loop or block; otherwise\n\
it is for the vector version.",
class vector_costs *,
@@ -2079,18 +2067,18 @@ HOOK_VECTOR_END (vectorize)
DEFHOOK
(preferred_else_value,
"This hook returns the target's preferred final argument for a call\n\
-to conditional internal function @var{ifn} (really of type\n\
-@code{internal_fn}). @var{type} specifies the return type of the\n\
-function and @var{ops} are the operands to the conditional operation,\n\
-of which there are @var{nops}.\n\
+to conditional internal function :samp:`{ifn}` (really of type\n\
+``internal_fn``). :samp:`{type}` specifies the return type of the\n\
+function and :samp:`{ops}` are the operands to the conditional operation,\n\
+of which there are :samp:`{nops}`.\n\
\n\
-For example, if @var{ifn} is @code{IFN_COND_ADD}, the hook returns\n\
-a value of type @var{type} that should be used when @samp{@var{ops}[0]}\n\
-and @samp{@var{ops}[1]} are conditionally added together.\n\
+For example, if :samp:`{ifn}` is ``IFN_COND_ADD``, the hook returns\n\
+a value of type :samp:`{type}` that should be used when :samp:`{ops}[0]`\n\
+and :samp:`{ops}[1]` are conditionally added together.\n\
\n\
This hook is only relevant if the target supports conditional patterns\n\
-like @code{cond_add@var{m}}. The default implementation returns a zero\n\
-constant of type @var{type}.",
+like ``cond_addm``. The default implementation returns a zero\n\
+constant of type :samp:`{type}`.",
tree,
(unsigned ifn, tree type, unsigned nops, tree *ops),
default_preferred_else_value)
@@ -2107,7 +2095,7 @@ DEFHOOKPOD
(absolute_biggest_alignment,
"If defined, this target hook specifies the absolute biggest alignment\n\
that a type or variable can have on this machine, otherwise,\n\
-@code{BIGGEST_ALIGNMENT} is used.",
+``BIGGEST_ALIGNMENT`` is used.",
HOST_WIDE_INT, BIGGEST_ALIGNMENT)
/* Allow target specific overriding of option settings after options have
@@ -2115,13 +2103,13 @@ that a type or variable can have on this machine, otherwise,\n\
end of the code affected by an attribute or pragma. */
DEFHOOK
(override_options_after_change,
- "This target function is similar to the hook @code{TARGET_OPTION_OVERRIDE}\n\
+ "This target function is similar to the hook ``TARGET_OPTION_OVERRIDE``\n\
but is called when the optimize level is changed via an attribute or\n\
pragma or when it is reset at the end of the code affected by the\n\
attribute or pragma. It is not called at the beginning of compilation\n\
-when @code{TARGET_OPTION_OVERRIDE} is called so if you want to perform these\n\
-actions then, you should have @code{TARGET_OPTION_OVERRIDE} call\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}.",
+when ``TARGET_OPTION_OVERRIDE`` is called so if you want to perform these\n\
+actions then, you should have ``TARGET_OPTION_OVERRIDE`` call\n\
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``.",
void, (void),
hook_void_void)
@@ -2129,9 +2117,9 @@ DEFHOOK
(offload_options,
"Used when writing out the list of options into an LTO file. It should\n\
translate any relevant target-specific options (such as the ABI in use)\n\
-into one of the @option{-foffload} options that exist as a common interface\n\
+into one of the :option:`-foffload` options that exist as a common interface\n\
to express such options. It should return a string containing these options,\n\
-separated by spaces, which the caller will free.\n",
+separated by spaces, which the caller will free.",
char *, (void), hook_charptr_void_null)
DEFHOOK_UNDOC
@@ -2145,7 +2133,7 @@ DEFHOOK
(libgcc_cmp_return_mode,
"This target hook should return the mode to be used for the return value\n\
of compare instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_cmp_return_mode)
@@ -2155,7 +2143,7 @@ DEFHOOK
(libgcc_shift_count_mode,
"This target hook should return the mode to be used for the shift count operand\n\
of shift instructions expanded to libgcc calls. If not defined\n\
-@code{word_mode} is returned which is the right choice for a majority of\n\
+``word_mode`` is returned which is the right choice for a majority of\n\
targets.",
scalar_int_mode, (void),
default_libgcc_shift_count_mode)
@@ -2163,8 +2151,8 @@ targets.",
/* Return machine mode to be used for _Unwind_Word type. */
DEFHOOK
(unwind_word_mode,
- "Return machine mode to be used for @code{_Unwind_Word} type.\n\
-The default is to use @code{word_mode}.",
+ "Return machine mode to be used for ``_Unwind_Word`` type.\n\
+The default is to use ``word_mode``.",
scalar_int_mode, (void),
default_unwind_word_mode)
@@ -2173,23 +2161,24 @@ DEFHOOK
(merge_decl_attributes,
"Define this target hook if the merging of decl attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{DECL_ATTRIBUTES} of @var{olddecl} and @var{newdecl}.\n\
-@var{newdecl} is a duplicate declaration of @var{olddecl}. Examples of\n\
+``DECL_ATTRIBUTES`` of :samp:`{olddecl}` and :samp:`{newdecl}`.\n\
+:samp:`{newdecl}` is a duplicate declaration of :samp:`{olddecl}`. Examples of\n\
when this is needed are when one attribute overrides another, or when an\n\
attribute is nullified by a subsequent definition. This function may\n\
-call @code{merge_attributes} to handle machine-independent merging.\n\
+call ``merge_attributes`` to handle machine-independent merging.\n\
+\n\
+.. index:: TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
\n\
-@findex TARGET_DLLIMPORT_DECL_ATTRIBUTES\n\
-If the only target-specific handling you require is @samp{dllimport}\n\
+If the only target-specific handling you require is :samp:`dllimport`\n\
for Microsoft Windows targets, you should define the macro\n\
-@code{TARGET_DLLIMPORT_DECL_ATTRIBUTES} to @code{1}. The compiler\n\
+``TARGET_DLLIMPORT_DECL_ATTRIBUTES`` to ``1``. The compiler\n\
will then define a function called\n\
-@code{merge_dllimport_decl_attributes} which can then be defined as\n\
-the expansion of @code{TARGET_MERGE_DECL_ATTRIBUTES}. You can also\n\
-add @code{handle_dll_attribute} in the attribute table for your port\n\
-to perform initial processing of the @samp{dllimport} and\n\
-@samp{dllexport} attributes. This is done in @file{i386/cygwin.h} and\n\
-@file{i386/i386.cc}, for example.",
+``merge_dllimport_decl_attributes`` which can then be defined as\n\
+the expansion of ``TARGET_MERGE_DECL_ATTRIBUTES``. You can also\n\
+add ``handle_dll_attribute`` in the attribute table for your port\n\
+to perform initial processing of the :samp:`dllimport` and\n\
+:samp:`dllexport` attributes. This is done in :samp:`i386/cygwin.h` and\n\
+:samp:`i386/i386.cc`, for example.",
tree, (tree olddecl, tree newdecl),
merge_decl_attributes)
@@ -2198,9 +2187,9 @@ DEFHOOK
(merge_type_attributes,
"Define this target hook if the merging of type attributes needs special\n\
handling. If defined, the result is a list of the combined\n\
-@code{TYPE_ATTRIBUTES} of @var{type1} and @var{type2}. It is assumed\n\
-that @code{comptypes} has already been called and returned 1. This\n\
-function may call @code{merge_attributes} to handle machine-independent\n\
+``TYPE_ATTRIBUTES`` of :samp:`{type1}` and :samp:`{type2}`. It is assumed\n\
+that ``comptypes`` has already been called and returned 1. This\n\
+function may call ``merge_attributes`` to handle machine-independent\n\
merging.",
tree, (tree type1, tree type2),
merge_type_attributes)
@@ -2209,8 +2198,8 @@ merging.",
Ignored if NULL. */
DEFHOOKPOD
(attribute_table,
- "If defined, this target hook points to an array of @samp{struct\n\
-attribute_spec} (defined in @file{tree-core.h}) specifying the machine\n\
+ "If defined, this target hook points to an array of :samp:`struct\n\
+attribute_spec` (defined in :samp:`tree-core.h`) specifying the machine\n\
specific attributes for this target and some of the restrictions on the\n\
entities to which these attributes are applied and the arguments they\n\
take.",
@@ -2221,7 +2210,7 @@ take.",
DEFHOOK
(attribute_takes_identifier_p,
"If defined, this target hook is a function which returns true if the\n\
-machine-specific attribute named @var{name} expects an identifier\n\
+machine-specific attribute named :samp:`{name}` expects an identifier\n\
given as its first argument to be passed on as a plain identifier, not\n\
subjected to name lookup. If this is not defined, the default is\n\
false for all machine-specific attributes.",
@@ -2234,7 +2223,7 @@ false for all machine-specific attributes.",
DEFHOOK
(comp_type_attributes,
"If defined, this target hook is a function which returns zero if the attributes on\n\
-@var{type1} and @var{type2} are incompatible, one if they are compatible,\n\
+:samp:`{type1}` and :samp:`{type2}` are incompatible, one if they are compatible,\n\
and two if they are nearly compatible (which causes a warning to be\n\
generated). If this is not defined, machine-specific attributes are\n\
supposed always to be compatible.",
@@ -2245,7 +2234,7 @@ supposed always to be compatible.",
DEFHOOK
(set_default_type_attributes,
"If defined, this target hook is a function which assigns default attributes to\n\
-the newly defined @var{type}.",
+the newly defined :samp:`{type}`.",
void, (tree type),
hook_void_tree)
@@ -2255,11 +2244,11 @@ DEFHOOK
"Define this target hook if you want to be able to add attributes to a decl\n\
when it is being created. This is normally useful for back ends which\n\
wish to implement a pragma by using the attributes which correspond to\n\
-the pragma's effect. The @var{node} argument is the decl which is being\n\
-created. The @var{attr_ptr} argument is a pointer to the attribute list\n\
+the pragma's effect. The :samp:`{node}` argument is the decl which is being\n\
+created. The :samp:`{attr_ptr}` argument is a pointer to the attribute list\n\
for this decl. The list itself should not be modified, since it may be\n\
shared with other decls, but attributes may be chained on the head of\n\
-the list and @code{*@var{attr_ptr}} modified to point to the new\n\
+the list and ``*attr_ptr`` modified to point to the new\n\
attributes, or a copy of the list may be made if further changes are\n\
needed.",
void, (tree node, tree *attr_ptr),
@@ -2271,8 +2260,8 @@ DEFHOOK
"Define this target hook if you want to be able to perform additional\n\
target-specific processing of an attribute which is handled generically\n\
by a front end. The arguments are the same as those which are passed to\n\
-attribute handlers. So far this only affects the @var{noinit} and\n\
-@var{section} attribute.",
+attribute handlers. So far this only affects the :samp:`{noinit}` and\n\
+:samp:`{section}` attribute.",
tree, (tree *node, tree name, tree args, int flags, bool *no_add_attrs),
hook_tree_treeptr_tree_tree_int_boolptr_null)
@@ -2280,10 +2269,11 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
can be inlined despite its machine attributes, false otherwise. */
DEFHOOK
(function_attribute_inlinable_p,
- "@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
+ ".. index:: inlining\n\
+\n\
+This target hook returns ``true`` if it is OK to inline :samp:`{fndecl}`\n\
into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
+attributes, ``false`` otherwise. By default, if a function has a\n\
target specific attribute attached to it, it will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -2292,8 +2282,8 @@ target specific attribute attached to it, it will not be inlined.",
Microsoft Visual C++ bitfield layout rules. */
DEFHOOK
(ms_bitfield_layout_p,
- "This target hook returns @code{true} if bit-fields in the given\n\
-@var{record_type} are to be laid out following the rules of Microsoft\n\
+ "This target hook returns ``true`` if bit-fields in the given\n\
+:samp:`{record_type}` are to be laid out following the rules of Microsoft\n\
Visual C/C++, namely: (i) a bit-field won't share the same storage\n\
unit with the previous bit-field if their underlying types have\n\
different sizes, and the bit-field will be aligned to the highest\n\
@@ -2301,7 +2291,7 @@ alignment of the underlying types of itself and of the previous\n\
bit-field; (ii) a zero-sized bit-field will affect the alignment of\n\
the whole enclosing structure, even if it is unnamed; except that\n\
(iii) a zero-sized bit-field will be disregarded unless it follows\n\
-another bit-field of nonzero size. If this hook returns @code{true},\n\
+another bit-field of nonzero size. If this hook returns ``true``,\n\
other macros that control bit-field layout are ignored.\n\
\n\
When a bit-field is inserted into a packed record, the whole size\n\
@@ -2312,8 +2302,8 @@ chunk of 32 bits. However, if the size changes, a new field of that\n\
size is allocated). In an unpacked record, this is the same as using\n\
alignment, but not equivalent when packing.\n\
\n\
-If both MS bit-fields and @samp{__attribute__((packed))} are used,\n\
-the latter will take precedence. If @samp{__attribute__((packed))} is\n\
+If both MS bit-fields and :samp:`__attribute__((packed))` are used,\n\
+the latter will take precedence. If :samp:`__attribute__((packed))` is\n\
used on a single field when MS bit-fields are in use, it will take\n\
precedence for that field, but the alignment of the rest of the structure\n\
may affect its placement.",
@@ -2340,8 +2330,8 @@ DEFHOOK
(float_exceptions_rounding_supported_p,
"Returns true if the target supports IEEE 754 floating-point exceptions\n\
and rounding modes, false otherwise. This is intended to relate to the\n\
-@code{float} and @code{double} types, but not necessarily @code{long double}.\n\
-By default, returns true if the @code{adddf3} instruction pattern is\n\
+``float`` and ``double`` types, but not necessarily ``long double``.\n\
+By default, returns true if the ``adddf3`` instruction pattern is\n\
available and false otherwise, on the assumption that hardware floating\n\
point supports exceptions and rounding modes but software floating point\n\
does not.",
@@ -2365,7 +2355,7 @@ DEFHOOK
/* Return true if anonymous bitfields affect structure alignment. */
DEFHOOK
(align_anon_bitfield,
- "When @code{PCC_BITFIELD_TYPE_MATTERS} is true this hook will determine\n\
+ "When ``PCC_BITFIELD_TYPE_MATTERS`` is true this hook will determine\n\
whether unnamed bitfields affect the alignment of the containing\n\
structure. The hook should return true if the structure should inherit\n\
the alignment requirements of an unnamed bitfield's type.",
@@ -2376,11 +2366,11 @@ the alignment requirements of an unnamed bitfield's type.",
Return false if they should use the container type. */
DEFHOOK
(narrow_volatile_bitfield,
- "This target hook should return @code{true} if accesses to volatile bitfields\n\
-should use the narrowest mode possible. It should return @code{false} if\n\
+ "This target hook should return ``true`` if accesses to volatile bitfields\n\
+should use the narrowest mode possible. It should return ``false`` if\n\
these accesses should use the bitfield container type.\n\
\n\
-The default is @code{false}.",
+The default is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -2397,11 +2387,11 @@ they have no equivalent in the source language (for example, SIMD vector\n\
instructions or prefetch instructions).\n\
\n\
To create a built-in function, call the function\n\
-@code{lang_hooks.builtin_function}\n\
+``lang_hooks.builtin_function``\n\
which is defined by the language front end. You can use any type nodes set\n\
-up by @code{build_common_tree_nodes};\n\
+up by ``build_common_tree_nodes`` ;\n\
only language front ends that use those two functions will call\n\
-@samp{TARGET_INIT_BUILTINS}.",
+:samp:`TARGET_INIT_BUILTINS`.",
void, (void),
hook_void_void)
@@ -2413,23 +2403,22 @@ DEFHOOK
(builtin_decl,
"Define this hook if you have any machine-specific built-in functions\n\
that need to be defined. It should be a function that returns the\n\
-builtin function declaration for the builtin function code @var{code}.\n\
+builtin function declaration for the builtin function code :samp:`{code}`.\n\
If there is no such builtin and it cannot be initialized at this time\n\
-if @var{initialize_p} is true the function should return @code{NULL_TREE}.\n\
-If @var{code} is out of range the function should return\n\
-@code{error_mark_node}.",
+if :samp:`{initialize_p}` is true the function should return ``NULL_TREE``.\n\
+If :samp:`{code}` is out of range the function should return\n\
+``error_mark_node``.",
tree, (unsigned code, bool initialize_p), NULL)
/* Expand a target-specific builtin. */
DEFHOOK
(expand_builtin,
- "\n\
-Expand a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{exp} is the expression for the\n\
-function call; the result should go to @var{target} if that is\n\
-convenient, and have mode @var{mode} if that is convenient.\n\
-@var{subtarget} may be used as the target for computing one of\n\
-@var{exp}'s operands. @var{ignore} is nonzero if the value is to be\n\
+ "Expand a call to a machine specific built-in function that was set up by\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{exp}` is the expression for the\n\
+function call; the result should go to :samp:`{target}` if that is\n\
+convenient, and have mode :samp:`{mode}` if that is convenient.\n\
+:samp:`{subtarget}` may be used as the target for computing one of\n\
+:samp:`{exp}` 's operands. :samp:`{ignore}` is nonzero if the value is to be\n\
ignored. This function should return the result of the call to the\n\
built-in function.",
rtx,
@@ -2444,14 +2433,14 @@ built-in function.",
DEFHOOK
(resolve_overloaded_builtin,
"Select a replacement for a machine specific built-in function that\n\
-was set up by @samp{TARGET_INIT_BUILTINS}. This is done\n\
-@emph{before} regular type checking, and so allows the target to\n\
-implement a crude form of function overloading. @var{fndecl} is the\n\
-declaration of the built-in function. @var{arglist} is the list of\n\
+was set up by :samp:`TARGET_INIT_BUILTINS`. This is done\n\
+*before* regular type checking, and so allows the target to\n\
+implement a crude form of function overloading. :samp:`{fndecl}` is the\n\
+declaration of the built-in function. :samp:`{arglist}` is the list of\n\
arguments passed to the built-in function. The result is a\n\
complete expression that implements the operation, usually\n\
-another @code{CALL_EXPR}.\n\
-@var{arglist} really has type @samp{VEC(tree,gc)*}",
+another ``CALL_EXPR``.\n\
+:samp:`{arglist}` really has type :samp:`VEC(tree,gc)*`",
tree, (unsigned int /*location_t*/ loc, tree fndecl, void *arglist), NULL)
DEFHOOK
@@ -2461,12 +2450,12 @@ function after its arguments have been constrained to the function\n\
signature. Return true if the call is valid, otherwise report an error\n\
and return false.\n\
\n\
-This hook is called after @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}.\n\
-The call was originally to built-in function @var{orig_fndecl},\n\
-but after the optional @code{TARGET_RESOLVE_OVERLOADED_BUILTIN}\n\
-step is now to built-in function @var{fndecl}. @var{loc} is the\n\
-location of the call and @var{args} is an array of function arguments,\n\
-of which there are @var{nargs}. @var{arg_loc} specifies the location\n\
+This hook is called after ``TARGET_RESOLVE_OVERLOADED_BUILTIN``.\n\
+The call was originally to built-in function :samp:`{orig_fndecl}`,\n\
+but after the optional ``TARGET_RESOLVE_OVERLOADED_BUILTIN``\n\
+step is now to built-in function :samp:`{fndecl}`. :samp:`{loc}` is the\n\
+location of the call and :samp:`{args}` is an array of function arguments,\n\
+of which there are :samp:`{nargs}`. :samp:`{arg_loc}` specifies the location\n\
of each argument.",
bool, (location_t loc, vec<location_t> arg_loc, tree fndecl,
tree orig_fndecl, unsigned int nargs, tree *args),
@@ -2477,12 +2466,12 @@ of each argument.",
DEFHOOK
(fold_builtin,
"Fold a call to a machine specific built-in function that was set up by\n\
-@samp{TARGET_INIT_BUILTINS}. @var{fndecl} is the declaration of the\n\
-built-in function. @var{n_args} is the number of arguments passed to\n\
-the function; the arguments themselves are pointed to by @var{argp}.\n\
+:samp:`TARGET_INIT_BUILTINS`. :samp:`{fndecl}` is the declaration of the\n\
+built-in function. :samp:`{n_args}` is the number of arguments passed to\n\
+the function; the arguments themselves are pointed to by :samp:`{argp}`.\n\
The result is another tree, valid for both GIMPLE and GENERIC,\n\
containing a simplified expression for the call's result. If\n\
-@var{ignore} is true the value will be ignored.",
+:samp:`{ignore}` is true the value will be ignored.",
tree, (tree fndecl, int n_args, tree *argp, bool ignore),
hook_tree_tree_int_treep_bool_null)
@@ -2490,7 +2479,7 @@ containing a simplified expression for the call's result. If\n\
DEFHOOK
(gimple_fold_builtin,
"Fold a call to a machine specific built-in function that was set up\n\
-by @samp{TARGET_INIT_BUILTINS}. @var{gsi} points to the gimple\n\
+by :samp:`TARGET_INIT_BUILTINS`. :samp:`{gsi}` points to the gimple\n\
statement holding the function call. Returns true if any change\n\
was made to the GIMPLE stream.",
bool, (gimple_stmt_iterator *gsi),
@@ -2510,8 +2499,8 @@ DEFHOOK
determine which function's features get higher priority. This is used\n\
during function multi-versioning to figure out the order in which two\n\
versions must be dispatched. A function version with a higher priority\n\
-is checked for dispatching earlier. @var{decl1} and @var{decl2} are\n\
- the two function decls that will be compared.",
+is checked for dispatching earlier. :samp:`{decl1}` and :samp:`{decl2}` are\n\
+the two function decls that will be compared.",
int, (tree decl1, tree decl2), NULL)
/* Target hook is used to generate the dispatcher logic to invoke the right
@@ -2522,7 +2511,7 @@ DEFHOOK
(generate_version_dispatcher_body,
"This hook is used to generate the dispatcher logic to invoke the right\n\
function version at run-time for a given set of function versions.\n\
-@var{arg} points to the callgraph node of the dispatcher function whose\n\
+:samp:`{arg}` points to the callgraph node of the dispatcher function whose\n\
body must be generated.",
tree, (void *arg), NULL)
@@ -2534,7 +2523,7 @@ DEFHOOK
(get_function_versions_dispatcher,
"This hook is used to get the dispatcher function for a set of function\n\
versions. The dispatcher function is called to invoke the right function\n\
-version at run-time. @var{decl} is one version from a set of semantically\n\
+version at run-time. :samp:`{decl}` is one version from a set of semantically\n\
identical versions.",
tree, (void *decl), NULL)
@@ -2543,8 +2532,8 @@ identical versions.",
DEFHOOK
(builtin_reciprocal,
"This hook should return the DECL of a function that implements the\n\
-reciprocal of the machine-specific builtin function @var{fndecl}, or\n\
-@code{NULL_TREE} if such a function is not available.",
+reciprocal of the machine-specific builtin function :samp:`{fndecl}`, or\n\
+``NULL_TREE`` if such a function is not available.",
tree, (tree fndecl),
default_builtin_reciprocal)
@@ -2556,32 +2545,32 @@ DEFHOOK
"If your target defines any fundamental types, or any types your target\n\
uses should be mangled differently from the default, define this hook\n\
to return the appropriate encoding for these types as part of a C++\n\
-mangled name. The @var{type} argument is the tree structure representing\n\
+mangled name. The :samp:`{type}` argument is the tree structure representing\n\
the type to be mangled. The hook may be applied to trees which are\n\
-not target-specific fundamental types; it should return @code{NULL}\n\
+not target-specific fundamental types; it should return ``NULL``\n\
for all such types, as well as arguments it does not recognize. If the\n\
-return value is not @code{NULL}, it must point to a statically-allocated\n\
+return value is not ``NULL``, it must point to a statically-allocated\n\
string constant.\n\
\n\
Target-specific fundamental types might be new fundamental types or\n\
qualified versions of ordinary fundamental types. Encode new\n\
-fundamental types as @samp{@w{u @var{n} @var{name}}}, where @var{name}\n\
-is the name used for the type in source code, and @var{n} is the\n\
-length of @var{name} in decimal. Encode qualified versions of\n\
-ordinary types as @samp{@w{U @var{n} @var{name} @var{code}}}, where\n\
-@var{name} is the name used for the type qualifier in source code,\n\
-@var{n} is the length of @var{name} as above, and @var{code} is the\n\
+fundamental types as :samp:`u {n}{name}`, where :samp:`{name}`\n\
+is the name used for the type in source code, and :samp:`{n}` is the\n\
+length of :samp:`{name}` in decimal. Encode qualified versions of\n\
+ordinary types as :samp:`U{n}{name}{code}`, where\n\
+:samp:`{name}` is the name used for the type qualifier in source code,\n\
+:samp:`{n}` is the length of :samp:`{name}` as above, and :samp:`{code}` is the\n\
code used to represent the unqualified version of this type. (See\n\
-@code{write_builtin_type} in @file{cp/mangle.cc} for the list of\n\
+``write_builtin_type`` in :samp:`cp/mangle.cc` for the list of\n\
codes.) In both cases the spaces are for clarity; do not include any\n\
spaces in your string.\n\
\n\
This hook is applied to types prior to typedef resolution. If the mangled\n\
name for a particular type depends only on that type's main variant, you\n\
-can perform typedef resolution yourself using @code{TYPE_MAIN_VARIANT}\n\
+can perform typedef resolution yourself using ``TYPE_MAIN_VARIANT``\n\
before mangling.\n\
\n\
-The default version of this hook always returns @code{NULL}, which is\n\
+The default version of this hook always returns ``NULL``, which is\n\
appropriate for a target that does not define any new fundamental\n\
types.",
const char *, (const_tree type),
@@ -2591,9 +2580,9 @@ types.",
DEFHOOK
(init_libfuncs,
"This hook should declare additional library routines or rename\n\
-existing ones, using the functions @code{set_optab_libfunc} and\n\
-@code{init_one_libfunc} defined in @file{optabs.cc}.\n\
-@code{init_optabs} calls this macro after initializing all the normal\n\
+existing ones, using the functions ``set_optab_libfunc`` and\n\
+``init_one_libfunc`` defined in :samp:`optabs.cc`.\n\
+``init_optabs`` calls this macro after initializing all the normal\n\
library routines.\n\
\n\
The default is to do nothing. Most ports don't need to define this hook.",
@@ -2604,11 +2593,11 @@ The default is to do nothing. Most ports don't need to define this hook.",
DEFHOOKPOD
(libfunc_gnu_prefix,
"If false (the default), internal library routines start with two\n\
-underscores. If set to true, these routines start with @code{__gnu_}\n\
-instead. E.g., @code{__muldi3} changes to @code{__gnu_muldi3}. This\n\
-currently only affects functions defined in @file{libgcc2.c}. If this\n\
-is set to true, the @file{tm.h} file must also\n\
-@code{#define LIBGCC2_GNU_PREFIX}.",
+underscores. If set to true, these routines start with ``__gnu_``\n\
+instead. E.g., ``__muldi3`` changes to ``__gnu_muldi3``. This\n\
+currently only affects functions defined in :samp:`libgcc2.c`. If this\n\
+is set to true, the :samp:`tm.h` file must also\n\
+``#define LIBGCC2_GNU_PREFIX``.",
bool, false)
/* Given a decl, a section name, and whether the decl initializer
@@ -2616,24 +2605,24 @@ is set to true, the @file{tm.h} file must also\n\
/* ??? Should be merged with SELECT_SECTION and UNIQUE_SECTION. */
DEFHOOK
(section_type_flags,
- "Choose a set of section attributes for use by @code{TARGET_ASM_NAMED_SECTION}\n\
+ "Choose a set of section attributes for use by ``TARGET_ASM_NAMED_SECTION``\n\
based on a variable or function decl, a section name, and whether or not the\n\
-declaration's initializer may contain runtime relocations. @var{decl} may be\n\
+declaration's initializer may contain runtime relocations. :samp:`{decl}` may be\n\
null, in which case read-write data should be assumed.\n\
\n\
The default version of this function handles choosing code vs data,\n\
-read-only vs read-write data, and @code{flag_pic}. You should only\n\
+read-only vs read-write data, and ``flag_pic``. You should only\n\
need to override this if your target has special flags that might be\n\
-set via @code{__attribute__}.",
+set via ``__attribute__``.",
unsigned int, (tree decl, const char *name, int reloc),
default_section_type_flags)
DEFHOOK
(libc_has_function,
"This hook determines whether a function from a class of functions\n\
-@var{fn_class} is present in the target C library. If @var{type} is NULL,\n\
+:samp:`{fn_class}` is present in the target C library. If :samp:`{type}` is NULL,\n\
the caller asks for support for all standard (float, double, long double)\n\
-types. If @var{type} is non-NULL, the caller asks for support for a\n\
+types. If :samp:`{type}` is non-NULL, the caller asks for support for a\n\
specific type.",
bool, (enum function_class fn_class, tree type),
default_libc_has_function)
@@ -2641,7 +2630,7 @@ specific type.",
DEFHOOK
(libc_has_fast_function,
"This hook determines whether a function from a class of functions\n\
-@code{(enum function_class)}@var{fcode} has a fast implementation.",
+ ``(enum function_class)``:samp:`{fcode}` has a fast implementation.",
bool, (int fcode),
default_libc_has_fast_function)
@@ -2649,18 +2638,18 @@ DEFHOOK
not, at the current point in the compilation. */
DEFHOOK
(cannot_modify_jumps_p,
- "This target hook returns @code{true} past the point in which new jump\n\
+ "This target hook returns ``true`` past the point in which new jump\n\
instructions could be created. On machines that require a register for\n\
every jump such as the SHmedia ISA of SH5, this point would typically be\n\
reload, so this target hook should be defined to a function such as:\n\
\n\
-@smallexample\n\
-static bool\n\
-cannot_modify_jumps_past_reload_p ()\n\
-@{\n\
- return (reload_completed || reload_in_progress);\n\
-@}\n\
-@end smallexample",
+.. code-block:: c++\n\
+\n\
+ static bool\n\
+ cannot_modify_jumps_past_reload_p ()\n\
+ {\n\
+ return (reload_completed || reload_in_progress);\n\
+ }",
bool, (void),
hook_bool_void_false)
@@ -2687,47 +2676,47 @@ modes and they have different conditional execution capability, such as ARM.",
DEFHOOK
(gen_ccmp_first,
"This function prepares to emit a comparison insn for the first compare in a\n\
- sequence of conditional comparisions. It returns an appropriate comparison\n\
- with @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.",
+sequence of conditional comparisions. It returns an appropriate comparison\n\
+with ``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, int code, tree op0, tree op1),
NULL)
DEFHOOK
(gen_ccmp_next,
"This function prepares to emit a conditional comparison within a sequence\n\
- of conditional comparisons. It returns an appropriate comparison with\n\
- @code{CC} for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- The insns to prepare the compare are saved in @var{prep_seq} and the compare\n\
- insns are saved in @var{gen_seq}. They will be emitted when all the\n\
- compares in the conditional comparision are generated without error. The\n\
- @var{prev} expression is the result of a prior call to @code{gen_ccmp_first}\n\
- or @code{gen_ccmp_next}. It may return @code{NULL} if the combination of\n\
- @var{prev} and this comparison is not supported, otherwise the result must\n\
- be appropriate for passing to @code{gen_ccmp_next} or @code{cbranch_optab}.\n\
- @var{code} is the @code{rtx_code} of the compare for @var{op0} and @var{op1}.\n\
- @var{bit_code} is @code{AND} or @code{IOR}, which is the op on the compares.",
+of conditional comparisons. It returns an appropriate comparison with\n\
+``CC`` for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+The insns to prepare the compare are saved in :samp:`{prep_seq}` and the compare\n\
+insns are saved in :samp:`{gen_seq}`. They will be emitted when all the\n\
+compares in the conditional comparision are generated without error. The\n\
+:samp:`{prev}` expression is the result of a prior call to ``gen_ccmp_first``\n\
+or ``gen_ccmp_next``. It may return ``NULL`` if the combination of\n\
+:samp:`{prev}` and this comparison is not supported, otherwise the result must\n\
+be appropriate for passing to ``gen_ccmp_next`` or ``cbranch_optab``.\n\
+:samp:`{code}` is the ``rtx_code`` of the compare for :samp:`{op0}` and :samp:`{op1}`.\n\
+:samp:`{bit_code}` is ``AND`` or ``IOR``, which is the op on the compares.",
rtx, (rtx_insn **prep_seq, rtx_insn **gen_seq, rtx prev, int cmp_code, tree op0, tree op1, int bit_code),
NULL)
DEFHOOK
(gen_memset_scratch_rtx,
- "This hook should return an rtx for a scratch register in @var{mode} to\n\
+ "This hook should return an rtx for a scratch register in :samp:`{mode}` to\n\
be used when expanding memset calls. The backend can use a hard scratch\n\
register to avoid stack realignment when expanding memset. The default\n\
-is @code{gen_reg_rtx}.",
+is ``gen_reg_rtx``.",
rtx, (machine_mode mode),
gen_reg_rtx)
/* Return a new value for loop unroll size. */
DEFHOOK
(loop_unroll_adjust,
- "This target hook returns a new value for the number of times @var{loop}\n\
-should be unrolled. The parameter @var{nunroll} is the number of times\n\
-the loop is to be unrolled. The parameter @var{loop} is a pointer to\n\
+ "This target hook returns a new value for the number of times :samp:`{loop}`\n\
+should be unrolled. The parameter :samp:`{nunroll}` is the number of times\n\
+the loop is to be unrolled. The parameter :samp:`{loop}` is a pointer to\n\
the loop, which is going to be checked for unrolling. This target hook\n\
is required only when the target has special constraints like maximum\n\
number of memory accesses.",
@@ -2737,9 +2726,9 @@ number of memory accesses.",
/* True if X is a legitimate MODE-mode immediate operand. */
DEFHOOK
(legitimate_constant_p,
- "This hook returns true if @var{x} is a legitimate constant for a\n\
-@var{mode}-mode immediate operand on the target machine. You can assume that\n\
-@var{x} satisfies @code{CONSTANT_P}, so you need not check this.\n\
+ "This hook returns true if :samp:`{x}` is a legitimate constant for a\n\
+:samp:`{mode}` -mode immediate operand on the target machine. You can assume that\n\
+:samp:`{x}` satisfies ``CONSTANT_P``, so you need not check this.\n\
\n\
The default definition returns true.",
bool, (machine_mode mode, rtx x),
@@ -2748,9 +2737,9 @@ The default definition returns true.",
/* True if X is a TLS operand whose value should be pre-computed. */
DEFHOOK
(precompute_tls_p,
- "This hook returns true if @var{x} is a TLS operand on the target\n\
+ "This hook returns true if :samp:`{x}` is a TLS operand on the target\n\
machine that should be pre-computed when used as the argument in a call.\n\
-You can assume that @var{x} satisfies @code{CONSTANT_P}, so you need not \n\
+You can assume that :samp:`{x}` satisfies ``CONSTANT_P``, so you need not \n\
check this.\n\
\n\
The default definition returns false.",
@@ -2760,9 +2749,9 @@ The default definition returns false.",
/* True if the constant X cannot be placed in the constant pool. */
DEFHOOK
(cannot_force_const_mem,
- "This hook should return true if @var{x} is of a form that cannot (or\n\
-should not) be spilled to the constant pool. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if :samp:`{x}` is of a form that cannot (or\n\
+should not) be spilled to the constant pool. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version of this hook returns false.\n\
\n\
@@ -2782,9 +2771,9 @@ DEFHOOK_UNDOC
/* True if X is considered to be commutative. */
DEFHOOK
(commutative_p,
- "This target hook returns @code{true} if @var{x} is considered to be commutative.\n\
-Usually, this is just COMMUTATIVE_P (@var{x}), but the HP PA doesn't consider\n\
-PLUS to be commutative inside a MEM@. @var{outer_code} is the rtx code\n\
+ "This target hook returns ``true`` if :samp:`{x}` is considered to be commutative.\n\
+Usually, this is just COMMUTATIVE_P (:samp:`{x}`), but the HP PA doesn't consider\n\
+PLUS to be commutative inside a MEM. :samp:`{outer_code}` is the rtx code\n\
of the enclosing rtl, if known, otherwise it is UNKNOWN.",
bool, (const_rtx x, int outer_code),
hook_bool_const_rtx_commutative_p)
@@ -2793,8 +2782,8 @@ of the enclosing rtl, if known, otherwise it is UNKNOWN.",
on the mode of the memory reference it is used in. */
DEFHOOK
(mode_dependent_address_p,
- "This hook returns @code{true} if memory address @var{addr} in address\n\
-space @var{addrspace} can have\n\
+ "This hook returns ``true`` if memory address :samp:`{addr}` in address\n\
+space :samp:`{addrspace}` can have\n\
different meanings depending on the machine mode of the memory\n\
reference it is used for or if the address is valid for some modes\n\
but not others.\n\
@@ -2804,9 +2793,9 @@ effects because the amount of the increment or decrement is the size\n\
of the operand being addressed. Some machines have other mode-dependent\n\
addresses. Many RISC machines have no mode-dependent addresses.\n\
\n\
-You may assume that @var{addr} is a valid address for the machine.\n\
+You may assume that :samp:`{addr}` is a valid address for the machine.\n\
\n\
-The default version of this hook returns @code{false}.",
+The default version of this hook returns ``false``.",
bool, (const_rtx addr, addr_space_t addrspace),
default_mode_dependent_address_p)
@@ -2814,24 +2803,25 @@ The default version of this hook returns @code{false}.",
ways to make it legitimate. Return X or an invalid address on failure. */
DEFHOOK
(legitimize_address,
- "This hook is given an invalid memory address @var{x} for an\n\
-operand of mode @var{mode} and should try to return a valid memory\n\
+ "This hook is given an invalid memory address :samp:`{x}` for an\n\
+operand of mode :samp:`{mode}` and should try to return a valid memory\n\
address.\n\
\n\
-@findex break_out_memory_refs\n\
-@var{x} will always be the result of a call to @code{break_out_memory_refs},\n\
-and @var{oldx} will be the operand that was given to that function to produce\n\
-@var{x}.\n\
+.. index:: break_out_memory_refs\n\
+\n\
+:samp:`{x}` will always be the result of a call to ``break_out_memory_refs``,\n\
+and :samp:`{oldx}` will be the operand that was given to that function to produce\n\
+:samp:`{x}`.\n\
\n\
The code of the hook should not alter the substructure of\n\
-@var{x}. If it transforms @var{x} into a more legitimate form, it\n\
-should return the new @var{x}.\n\
+:samp:`{x}`. If it transforms :samp:`{x}` into a more legitimate form, it\n\
+should return the new :samp:`{x}`.\n\
\n\
It is not necessary for this hook to come up with a legitimate address,\n\
-with the exception of native TLS addresses (@pxref{Emulated TLS}).\n\
+with the exception of native TLS addresses (see :ref:`emulated-tls`).\n\
The compiler has standard ways of doing so in all cases. In fact, if\n\
the target supports only emulated TLS, it\n\
-is safe to omit this hook or make it return @var{x} if it cannot find\n\
+is safe to omit this hook or make it return :samp:`{x}` if it cannot find\n\
a valid way to legitimize the address. But often a machine-dependent\n\
strategy can generate better code.",
rtx, (rtx x, rtx oldx, machine_mode mode),
@@ -2841,11 +2831,11 @@ strategy can generate better code.",
DEFHOOK
(delegitimize_address,
"This hook is used to undo the possibly obfuscating effects of the\n\
-@code{LEGITIMIZE_ADDRESS} and @code{LEGITIMIZE_RELOAD_ADDRESS} target\n\
+``LEGITIMIZE_ADDRESS`` and ``LEGITIMIZE_RELOAD_ADDRESS`` target\n\
macros. Some backend implementations of these macros wrap symbol\n\
-references inside an @code{UNSPEC} rtx to represent PIC or similar\n\
+references inside an ``UNSPEC`` rtx to represent PIC or similar\n\
addressing modes. This target hook allows GCC's optimizers to understand\n\
-the semantics of these opaque @code{UNSPEC}s by converting them back\n\
+the semantics of these opaque ``UNSPEC`` s by converting them back\n\
into their original form.",
rtx, (rtx x),
delegitimize_mem_from_attrs)
@@ -2854,7 +2844,7 @@ into their original form.",
section. */
DEFHOOK
(const_not_ok_for_debug_p,
- "This hook should return true if @var{x} should not be emitted into\n\
+ "This hook should return true if :samp:`{x}` should not be emitted into\n\
debug sections.",
bool, (rtx x),
default_const_not_ok_for_debug_p)
@@ -2862,11 +2852,11 @@ debug sections.",
/* Given an address RTX, say whether it is valid. */
DEFHOOK
(legitimate_address_p,
- "A function that returns whether @var{x} (an RTX) is a legitimate memory\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+ "A function that returns whether :samp:`{x}` (an RTX) is a legitimate memory\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
Legitimate addresses are defined in two variants: a strict variant and a\n\
-non-strict one. The @var{strict} parameter chooses which variant is\n\
+non-strict one. The :samp:`{strict}` parameter chooses which variant is\n\
desired by the caller.\n\
\n\
The strict variant is used in the reload pass. It must be defined so\n\
@@ -2874,52 +2864,53 @@ that any pseudo-register that has not been allocated a hard register is\n\
considered a memory reference. This is because in contexts where some\n\
kind of register is required, a pseudo-register with no hard register\n\
must be rejected. For non-hard registers, the strict variant should look\n\
-up the @code{reg_renumber} array; it should then proceed using the hard\n\
+up the ``reg_renumber`` array; it should then proceed using the hard\n\
register number in the array, or treat the pseudo as a memory reference\n\
-if the array holds @code{-1}.\n\
+if the array holds ``-1``.\n\
\n\
The non-strict variant is used in other passes. It must be defined to\n\
accept all pseudo-registers in every context where some kind of\n\
register is required.\n\
\n\
-Normally, constant addresses which are the sum of a @code{symbol_ref}\n\
-and an integer are stored inside a @code{const} RTX to mark them as\n\
+Normally, constant addresses which are the sum of a ``symbol_ref``\n\
+and an integer are stored inside a ``const`` RTX to mark them as\n\
constant. Therefore, there is no need to recognize such sums\n\
specifically as legitimate addresses. Normally you would simply\n\
-recognize any @code{const} as legitimate.\n\
+recognize any ``const`` as legitimate.\n\
\n\
-Usually @code{PRINT_OPERAND_ADDRESS} is not prepared to handle constant\n\
-sums that are not marked with @code{const}. It assumes that a naked\n\
-@code{plus} indicates indexing. If so, then you @emph{must} reject such\n\
+Usually ``PRINT_OPERAND_ADDRESS`` is not prepared to handle constant\n\
+sums that are not marked with ``const``. It assumes that a naked\n\
+``plus`` indicates indexing. If so, then you *must* reject such\n\
naked constant sums as illegitimate addresses, so that none of them will\n\
-be given to @code{PRINT_OPERAND_ADDRESS}.\n\
+be given to ``PRINT_OPERAND_ADDRESS``.\n\
+\n\
+.. index:: TARGET_ENCODE_SECTION_INFO and address validation\n\
\n\
-@cindex @code{TARGET_ENCODE_SECTION_INFO} and address validation\n\
On some machines, whether a symbolic address is legitimate depends on\n\
the section that the address refers to. On these machines, define the\n\
-target hook @code{TARGET_ENCODE_SECTION_INFO} to store the information\n\
-into the @code{symbol_ref}, and then check for it here. When you see a\n\
-@code{const}, you will have to look inside it to find the\n\
-@code{symbol_ref} in order to determine the section. @xref{Assembler\n\
-Format}.\n\
+target hook ``TARGET_ENCODE_SECTION_INFO`` to store the information\n\
+into the ``symbol_ref``, and then check for it here. When you see a\n\
+``const``, you will have to look inside it to find the\n\
+``symbol_ref`` in order to determine the section. See :ref:`assembler-format`.\n\
+\n\
+.. index:: GO_IF_LEGITIMATE_ADDRESS\n\
\n\
-@cindex @code{GO_IF_LEGITIMATE_ADDRESS}\n\
Some ports are still using a deprecated legacy substitute for\n\
-this hook, the @code{GO_IF_LEGITIMATE_ADDRESS} macro. This macro\n\
+this hook, the ``GO_IF_LEGITIMATE_ADDRESS`` macro. This macro\n\
has this syntax:\n\
\n\
-@example\n\
-#define GO_IF_LEGITIMATE_ADDRESS (@var{mode}, @var{x}, @var{label})\n\
-@end example\n\
+.. code-block:: c++\n\
+\n\
+ #define GO_IF_LEGITIMATE_ADDRESS (mode, x, label)\n\
+\n\
+and should ``goto label`` if the address :samp:`{x}` is a valid\n\
+address on the target machine for a memory operand of mode :samp:`{mode}`.\n\
\n\
-@noindent\n\
-and should @code{goto @var{label}} if the address @var{x} is a valid\n\
-address on the target machine for a memory operand of mode @var{mode}.\n\
+.. index:: REG_OK_STRICT\n\
\n\
-@findex REG_OK_STRICT\n\
Compiler source files that want to use the strict variant of this\n\
-macro define the macro @code{REG_OK_STRICT}. You should use an\n\
-@code{#ifdef REG_OK_STRICT} conditional to define the strict variant in\n\
+macro define the macro ``REG_OK_STRICT``. You should use an\n\
+``#ifdef REG_OK_STRICT`` conditional to define the strict variant in\n\
that case and the non-strict variant otherwise.\n\
\n\
Using the hook is usually simpler because it limits the number of\n\
@@ -2930,9 +2921,9 @@ files that are recompiled when changes are made.",
/* True if the given constant can be put into an object_block. */
DEFHOOK
(use_blocks_for_constant_p,
- "This hook should return true if pool entries for constant @var{x} can\n\
-be placed in an @code{object_block} structure. @var{mode} is the mode\n\
-of @var{x}.\n\
+ "This hook should return true if pool entries for constant :samp:`{x}` can\n\
+be placed in an ``object_block`` structure. :samp:`{mode}` is the mode\n\
+of :samp:`{x}`.\n\
\n\
The default version returns false for all constants.",
bool, (machine_mode mode, const_rtx x),
@@ -2941,8 +2932,8 @@ The default version returns false for all constants.",
/* True if the given decl can be put into an object_block. */
DEFHOOK
(use_blocks_for_decl_p,
- "This hook should return true if pool entries for @var{decl} should\n\
-be placed in an @code{object_block} structure.\n\
+ "This hook should return true if pool entries for :samp:`{decl}` should\n\
+be placed in an ``object_block`` structure.\n\
\n\
The default version returns true for all decls.",
bool, (const_tree decl),
@@ -2959,7 +2950,7 @@ for every mode. The default value is 0.",
DEFHOOKPOD
(max_anchor_offset,
- "Like @code{TARGET_MIN_ANCHOR_OFFSET}, but the maximum (inclusive)\n\
+ "Like ``TARGET_MIN_ANCHOR_OFFSET``, but the maximum (inclusive)\n\
offset that should be applied to section anchors. The default\n\
value is 0.",
HOST_WIDE_INT, 0)
@@ -2967,9 +2958,9 @@ value is 0.",
/* True if section anchors can be used to access the given symbol. */
DEFHOOK
(use_anchors_for_symbol_p,
- "Return true if GCC should attempt to use anchors to access @code{SYMBOL_REF}\n\
-@var{x}. You can assume @samp{SYMBOL_REF_HAS_BLOCK_INFO_P (@var{x})} and\n\
-@samp{!SYMBOL_REF_ANCHOR_P (@var{x})}.\n\
+ "Return true if GCC should attempt to use anchors to access ``SYMBOL_REF``\n\
+:samp:`{x}`. You can assume :samp:`SYMBOL_REF_HAS_BLOCK_INFO_P ({x})` and\n\
+:samp:`!SYMBOL_REF_ANCHOR_P ({x})`.\n\
\n\
The default version is correct for most targets, but you might need to\n\
intercept this hook to handle things like target-specific attributes\n\
@@ -3000,14 +2991,14 @@ locally. The default is to return false.",
DEFHOOK
(function_ok_for_sibcall,
"True if it is OK to do sibling call optimization for the specified\n\
-call expression @var{exp}. @var{decl} will be the called function,\n\
-or @code{NULL} if this is an indirect call.\n\
+call expression :samp:`{exp}`. :samp:`{decl}` will be the called function,\n\
+or ``NULL`` if this is an indirect call.\n\
\n\
It is not uncommon for limitations of calling conventions to prevent\n\
tail calls to functions outside the current unit of translation, or\n\
during PIC compilation. The hook is used to enforce these restrictions,\n\
-as the @code{sibcall} md pattern cannot fail, or fall over to a\n\
-``normal'' call. The criteria for successful sibling call optimization\n\
+as the ``sibcall`` md pattern cannot fail, or fall over to a\n\
+'normal' call. The criteria for successful sibling call optimization\n\
may vary greatly between different architectures.",
bool, (tree decl, tree exp),
hook_bool_tree_tree_false)
@@ -3018,27 +3009,27 @@ may vary greatly between different architectures.",
DEFHOOK
(set_current_function,
"The compiler invokes this hook whenever it changes its current function\n\
-context (@code{cfun}). You can define this function if\n\
+context (``cfun``). You can define this function if\n\
the back end needs to perform any initialization or reset actions on a\n\
per-function basis. For example, it may be used to implement function\n\
attributes that affect register usage or code generation patterns.\n\
-The argument @var{decl} is the declaration for the new function context,\n\
+The argument :samp:`{decl}` is the declaration for the new function context,\n\
and may be null to indicate that the compiler has left a function context\n\
and is returning to processing at the top level.\n\
The default hook function does nothing.\n\
\n\
-GCC sets @code{cfun} to a dummy function context during initialization of\n\
+GCC sets ``cfun`` to a dummy function context during initialization of\n\
some parts of the back end. The hook function is not invoked in this\n\
situation; you need not worry about the hook being invoked recursively,\n\
or when the back end is in a partially-initialized state.\n\
-@code{cfun} might be @code{NULL} to indicate processing at top level,\n\
+``cfun`` might be ``NULL`` to indicate processing at top level,\n\
outside of any function scope.",
void, (tree decl), hook_void_tree)
/* True if EXP should be placed in a "small data" section. */
DEFHOOK
(in_small_data_p,
- "Returns true if @var{exp} should be placed into a ``small data'' section.\n\
+ "Returns true if :samp:`{exp}` should be placed into a 'small data' section.\n\
The default version of this hook always returns false.",
bool, (const_tree exp),
hook_bool_const_tree_false)
@@ -3047,8 +3038,8 @@ The default version of this hook always returns false.",
to the current executable or shared library. */
DEFHOOK
(binds_local_p,
- "Returns true if @var{exp} names an object for which name resolution\n\
-rules must resolve to the current ``module'' (dynamic shared library\n\
+ "Returns true if :samp:`{exp}` names an object for which name resolution\n\
+rules must resolve to the current 'module' (dynamic shared library\n\
or executable image).\n\
\n\
The default version of this hook implements the name resolution rules\n\
@@ -3060,9 +3051,10 @@ currently supported object file formats.",
/* Check if profiling code is before or after prologue. */
DEFHOOK
(profile_before_prologue,
- "It returns true if target wants profile code emitted before prologue.\n\n\
+ "It returns true if target wants profile code emitted before prologue.\n\
+\n\
The default version of this hook use the target macro\n\
-@code{PROFILE_BEFORE_PROLOGUE}.",
+``PROFILE_BEFORE_PROLOGUE``.",
bool, (void),
default_profile_before_prologue)
@@ -3085,12 +3077,12 @@ mcount is generated before the function prologue.",
DEFHOOK
(mangle_decl_assembler_name,
"Define this hook if you need to postprocess the assembler name generated\n\
-by target-independent code. The @var{id} provided to this hook will be\n\
-the computed name (e.g., the macro @code{DECL_NAME} of the @var{decl} in C,\n\
-or the mangled name of the @var{decl} in C++). The return value of the\n\
-hook is an @code{IDENTIFIER_NODE} for the appropriate mangled name on\n\
+by target-independent code. The :samp:`{id}` provided to this hook will be\n\
+the computed name (e.g., the macro ``DECL_NAME`` of the :samp:`{decl}` in C,\n\
+or the mangled name of the :samp:`{decl}` in C++). The return value of the\n\
+hook is an ``IDENTIFIER_NODE`` for the appropriate mangled name on\n\
your target system. The default implementation of this hook just\n\
-returns the @var{id} provided.",
+returns the :samp:`{id}` provided.",
tree, (tree decl, tree id),
default_mangle_decl_assembler_name)
@@ -3103,35 +3095,36 @@ treated differently depending on something about the variable or\n\
function named by the symbol (such as what section it is in).\n\
\n\
The hook is executed immediately after rtl has been created for\n\
-@var{decl}, which may be a variable or function declaration or\n\
-an entry in the constant pool. In either case, @var{rtl} is the\n\
-rtl in question. Do @emph{not} use @code{DECL_RTL (@var{decl})}\n\
+:samp:`{decl}`, which may be a variable or function declaration or\n\
+an entry in the constant pool. In either case, :samp:`{rtl}` is the\n\
+rtl in question. Do *not* use ``DECL_RTL (decl)``\n\
in this hook; that field may not have been initialized yet.\n\
\n\
In the case of a constant, it is safe to assume that the rtl is\n\
-a @code{mem} whose address is a @code{symbol_ref}. Most decls\n\
+a ``mem`` whose address is a ``symbol_ref``. Most decls\n\
will also have this form, but that is not guaranteed. Global\n\
-register variables, for instance, will have a @code{reg} for their\n\
+register variables, for instance, will have a ``reg`` for their\n\
rtl. (Normally the right thing to do with such unusual rtl is\n\
leave it alone.)\n\
\n\
-The @var{new_decl_p} argument will be true if this is the first time\n\
-that @code{TARGET_ENCODE_SECTION_INFO} has been invoked on this decl. It will\n\
+The :samp:`{new_decl_p}` argument will be true if this is the first time\n\
+that ``TARGET_ENCODE_SECTION_INFO`` has been invoked on this decl. It will\n\
be false for subsequent invocations, which will happen for duplicate\n\
declarations. Whether or not anything must be done for the duplicate\n\
-declaration depends on whether the hook examines @code{DECL_ATTRIBUTES}.\n\
-@var{new_decl_p} is always true when the hook is called for a constant.\n\
+declaration depends on whether the hook examines ``DECL_ATTRIBUTES``.\n\
+:samp:`{new_decl_p}` is always true when the hook is called for a constant.\n\
+\n\
+.. index:: SYMBOL_REF_FLAG, in TARGET_ENCODE_SECTION_INFO\n\
\n\
-@cindex @code{SYMBOL_REF_FLAG}, in @code{TARGET_ENCODE_SECTION_INFO}\n\
The usual thing for this hook to do is to record flags in the\n\
-@code{symbol_ref}, using @code{SYMBOL_REF_FLAG} or @code{SYMBOL_REF_FLAGS}.\n\
+``symbol_ref``, using ``SYMBOL_REF_FLAG`` or ``SYMBOL_REF_FLAGS``.\n\
Historically, the name string was modified if it was necessary to\n\
encode more than one bit of information, but this practice is now\n\
-discouraged; use @code{SYMBOL_REF_FLAGS}.\n\
+discouraged; use ``SYMBOL_REF_FLAGS``.\n\
\n\
-The default definition of this hook, @code{default_encode_section_info}\n\
-in @file{varasm.cc}, sets a number of commonly-useful bits in\n\
-@code{SYMBOL_REF_FLAGS}. Check whether the default does what you need\n\
+The default definition of this hook, ``default_encode_section_info``\n\
+in :samp:`varasm.cc`, sets a number of commonly-useful bits in\n\
+``SYMBOL_REF_FLAGS``. Check whether the default does what you need\n\
before overriding it.",
void, (tree decl, rtx rtl, int new_decl_p),
default_encode_section_info)
@@ -3139,8 +3132,8 @@ before overriding it.",
/* Undo the effects of encode_section_info on the symbol string. */
DEFHOOK
(strip_name_encoding,
- "Decode @var{name} and return the real name part, sans\n\
-the characters that @code{TARGET_ENCODE_SECTION_INFO}\n\
+ "Decode :samp:`{name}` and return the real name part, sans\n\
+the characters that ``TARGET_ENCODE_SECTION_INFO``\n\
may have added.",
const char *, (const char *name),
default_strip_name_encoding)
@@ -3149,25 +3142,25 @@ may have added.",
return the mask that they apply. Return 0 otherwise. */
DEFHOOK
(shift_truncation_mask,
- "This function describes how the standard shift patterns for @var{mode}\n\
+ "This function describes how the standard shift patterns for :samp:`{mode}`\n\
deal with shifts by negative amounts or by more than the width of the mode.\n\
-@xref{shift patterns}.\n\
+See :ref:`shift-patterns`.\n\
\n\
-On many machines, the shift patterns will apply a mask @var{m} to the\n\
-shift count, meaning that a fixed-width shift of @var{x} by @var{y} is\n\
-equivalent to an arbitrary-width shift of @var{x} by @var{y & m}. If\n\
-this is true for mode @var{mode}, the function should return @var{m},\n\
+On many machines, the shift patterns will apply a mask :samp:`{m}` to the\n\
+shift count, meaning that a fixed-width shift of :samp:`{x}` by :samp:`{y}` is\n\
+equivalent to an arbitrary-width shift of :samp:`{x}` by :samp:`{y & m}`. If\n\
+this is true for mode :samp:`{mode}`, the function should return :samp:`{m}`,\n\
otherwise it should return 0. A return value of 0 indicates that no\n\
particular behavior is guaranteed.\n\
\n\
-Note that, unlike @code{SHIFT_COUNT_TRUNCATED}, this function does\n\
-@emph{not} apply to general shift rtxes; it applies only to instructions\n\
+Note that, unlike ``SHIFT_COUNT_TRUNCATED``, this function does\n\
+*not* apply to general shift rtxes; it applies only to instructions\n\
that are generated by the named shift patterns.\n\
\n\
The default implementation of this function returns\n\
-@code{GET_MODE_BITSIZE (@var{mode}) - 1} if @code{SHIFT_COUNT_TRUNCATED}\n\
+``GET_MODE_BITSIZE (mode) - 1`` if ``SHIFT_COUNT_TRUNCATED``\n\
and 0 otherwise. This definition is always safe, but if\n\
-@code{SHIFT_COUNT_TRUNCATED} is false, and some shift patterns\n\
+``SHIFT_COUNT_TRUNCATED`` is false, and some shift patterns\n\
nevertheless truncate the shift count, you may get better code\n\
by overriding it.",
unsigned HOST_WIDE_INT, (machine_mode mode),
@@ -3178,26 +3171,26 @@ by overriding it.",
the reciprocal. */
DEFHOOK
(min_divisions_for_recip_mul,
- "When @option{-ffast-math} is in effect, GCC tries to optimize\n\
+ "When :option:`-ffast-math` is in effect, GCC tries to optimize\n\
divisions by the same divisor, by turning them into multiplications by\n\
the reciprocal. This target hook specifies the minimum number of divisions\n\
that should be there for GCC to perform the optimization for a variable\n\
-of mode @var{mode}. The default implementation returns 3 if the machine\n\
+of mode :samp:`{mode}`. The default implementation returns 3 if the machine\n\
has an instruction for the division, and 2 if it does not.",
unsigned int, (machine_mode mode),
default_min_divisions_for_recip_mul)
DEFHOOK
(truly_noop_truncation,
- "This hook returns true if it is safe to ``convert'' a value of\n\
-@var{inprec} bits to one of @var{outprec} bits (where @var{outprec} is\n\
-smaller than @var{inprec}) by merely operating on it as if it had only\n\
-@var{outprec} bits. The default returns true unconditionally, which\n\
-is correct for most machines. When @code{TARGET_TRULY_NOOP_TRUNCATION}\n\
-returns false, the machine description should provide a @code{trunc}\n\
+ "This hook returns true if it is safe to 'convert' a value of\n\
+:samp:`{inprec}` bits to one of :samp:`{outprec}` bits (where :samp:`{outprec}` is\n\
+smaller than :samp:`{inprec}`) by merely operating on it as if it had only\n\
+:samp:`{outprec}` bits. The default returns true unconditionally, which\n\
+is correct for most machines. When ``TARGET_TRULY_NOOP_TRUNCATION``\n\
+returns false, the machine description should provide a ``trunc``\n\
optab to specify the RTL that performs the required truncation.\n\
\n\
-If @code{TARGET_MODES_TIEABLE_P} returns false for a pair of modes,\n\
+If ``TARGET_MODES_TIEABLE_P`` returns false for a pair of modes,\n\
suboptimal code can result if this hook returns true for the corresponding\n\
mode sizes. Making this hook return false in such cases may improve things.",
bool, (poly_uint64 outprec, poly_uint64 inprec),
@@ -3212,44 +3205,44 @@ DEFHOOK
(mode_rep_extended,
"The representation of an integral mode can be such that the values\n\
are always extended to a wider integral mode. Return\n\
-@code{SIGN_EXTEND} if values of @var{mode} are represented in\n\
-sign-extended form to @var{rep_mode}. Return @code{UNKNOWN}\n\
+``SIGN_EXTEND`` if values of :samp:`{mode}` are represented in\n\
+sign-extended form to :samp:`{rep_mode}`. Return ``UNKNOWN``\n\
otherwise. (Currently, none of the targets use zero-extended\n\
-representation this way so unlike @code{LOAD_EXTEND_OP},\n\
-@code{TARGET_MODE_REP_EXTENDED} is expected to return either\n\
-@code{SIGN_EXTEND} or @code{UNKNOWN}. Also no target extends\n\
-@var{mode} to @var{rep_mode} so that @var{rep_mode} is not the next\n\
+representation this way so unlike ``LOAD_EXTEND_OP``,\n\
+``TARGET_MODE_REP_EXTENDED`` is expected to return either\n\
+``SIGN_EXTEND`` or ``UNKNOWN``. Also no target extends\n\
+:samp:`{mode}` to :samp:`{rep_mode}` so that :samp:`{rep_mode}` is not the next\n\
widest integral mode and currently we take advantage of this fact.)\n\
\n\
-Similarly to @code{LOAD_EXTEND_OP} you may return a non-@code{UNKNOWN}\n\
+Similarly to ``LOAD_EXTEND_OP`` you may return a non- ``UNKNOWN``\n\
value even if the extension is not performed on certain hard registers\n\
-as long as for the @code{REGNO_REG_CLASS} of these hard registers\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} returns false.\n\
+as long as for the ``REGNO_REG_CLASS`` of these hard registers\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` returns false.\n\
\n\
-Note that @code{TARGET_MODE_REP_EXTENDED} and @code{LOAD_EXTEND_OP}\n\
+Note that ``TARGET_MODE_REP_EXTENDED`` and ``LOAD_EXTEND_OP``\n\
describe two related properties. If you define\n\
-@code{TARGET_MODE_REP_EXTENDED (mode, word_mode)} you probably also want\n\
-to define @code{LOAD_EXTEND_OP (mode)} to return the same type of\n\
+``TARGET_MODE_REP_EXTENDED (mode, word_mode)`` you probably also want\n\
+to define ``LOAD_EXTEND_OP (mode)`` to return the same type of\n\
extension.\n\
\n\
-In order to enforce the representation of @code{mode},\n\
-@code{TARGET_TRULY_NOOP_TRUNCATION} should return false when truncating to\n\
-@code{mode}.",
+In order to enforce the representation of ``mode``,\n\
+``TARGET_TRULY_NOOP_TRUNCATION`` should return false when truncating to\n\
+``mode``.",
int, (scalar_int_mode mode, scalar_int_mode rep_mode),
default_mode_rep_extended)
DEFHOOK
(setjmp_preserves_nonvolatile_regs_p,
"On some targets, it is assumed that the compiler will spill all pseudos\n\
- that are live across a call to @code{setjmp}, while other targets treat\n\
- @code{setjmp} calls as normal function calls.\n\
- \n\
- This hook returns false if @code{setjmp} calls do not preserve all\n\
- non-volatile registers so that gcc that must spill all pseudos that are\n\
- live across @code{setjmp} calls. Define this to return true if the\n\
- target does not need to spill all pseudos live across @code{setjmp} calls.\n\
- The default implementation conservatively assumes all pseudos must be\n\
- spilled across @code{setjmp} calls.",
+that are live across a call to ``setjmp``, while other targets treat\n\
+``setjmp`` calls as normal function calls.\n\
+\n\
+This hook returns false if ``setjmp`` calls do not preserve all\n\
+non-volatile registers so that gcc that must spill all pseudos that are\n\
+live across ``setjmp`` calls. Define this to return true if the\n\
+target does not need to spill all pseudos live across ``setjmp`` calls.\n\
+The default implementation conservatively assumes all pseudos must be\n\
+spilled across ``setjmp`` calls.",
bool, (void),
hook_bool_void_false)
@@ -3257,15 +3250,15 @@ DEFHOOK
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode}. The default version of this\n\
-hook returns true for both @code{ptr_mode} and @code{Pmode}.",
+with machine mode :samp:`{mode}`. The default version of this\n\
+hook returns true for both ``ptr_mode`` and ``Pmode``.",
bool, (scalar_int_mode mode),
default_valid_pointer_mode)
/* Disambiguate with errno. */
DEFHOOK
(ref_may_alias_errno,
- "Define this to return nonzero if the memory reference @var{ref}\n\
+ "Define this to return nonzero if the memory reference :samp:`{ref}`\n\
may alias with the system C library errno location. The default\n\
version of this hook assumes the system C library errno location\n\
is either a declaration of type int or accessed by dereferencing\n\
@@ -3282,8 +3275,8 @@ HOOK_VECTOR (TARGET_ADDR_SPACE_HOOKS, addr_space)
DEFHOOK
(pointer_mode,
"Define this to return the machine mode to use for pointers to\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{ptr_mode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``ptr_mode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_pointer_mode)
@@ -3291,8 +3284,8 @@ The default version of this hook returns @code{ptr_mode}.",
DEFHOOK
(address_mode,
"Define this to return the machine mode to use for addresses in\n\
-@var{address_space} if the target supports named address spaces.\n\
-The default version of this hook returns @code{Pmode}.",
+:samp:`{address_space}` if the target supports named address spaces.\n\
+The default version of this hook returns ``Pmode``.",
scalar_int_mode, (addr_space_t address_space),
default_addr_space_address_mode)
@@ -3301,11 +3294,11 @@ The default version of this hook returns @code{Pmode}.",
DEFHOOK
(valid_pointer_mode,
"Define this to return nonzero if the port can handle pointers\n\
-with machine mode @var{mode} to address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_VALID_POINTER_MODE} target hook,\n\
+with machine mode :samp:`{mode}` to address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_VALID_POINTER_MODE`` target hook,\n\
except that it includes explicit named address space support. The default\n\
version of this hook returns true for the modes returned by either the\n\
-@code{TARGET_ADDR_SPACE_POINTER_MODE} or @code{TARGET_ADDR_SPACE_ADDRESS_MODE}\n\
+``TARGET_ADDR_SPACE_POINTER_MODE`` or ``TARGET_ADDR_SPACE_ADDRESS_MODE``\n\
target hooks for the given address space.",
bool, (scalar_int_mode mode, addr_space_t as),
default_addr_space_valid_pointer_mode)
@@ -3314,11 +3307,11 @@ target hooks for the given address space.",
space for a given mode. */
DEFHOOK
(legitimate_address_p,
- "Define this to return true if @var{exp} is a valid address for mode\n\
-@var{mode} in the named address space @var{as}. The @var{strict}\n\
+ "Define this to return true if :samp:`{exp}` is a valid address for mode\n\
+:samp:`{mode}` in the named address space :samp:`{as}`. The :samp:`{strict}`\n\
parameter says whether strict addressing is in effect after reload has\n\
finished. This target hook is the same as the\n\
-@code{TARGET_LEGITIMATE_ADDRESS_P} target hook, except that it includes\n\
+``TARGET_LEGITIMATE_ADDRESS_P`` target hook, except that it includes\n\
explicit named address space support.",
bool, (machine_mode mode, rtx exp, bool strict, addr_space_t as),
default_addr_space_legitimate_address_p)
@@ -3328,9 +3321,9 @@ explicit named address space support.",
independent methods to make the address valid. */
DEFHOOK
(legitimize_address,
- "Define this to modify an invalid address @var{x} to be a valid address\n\
-with mode @var{mode} in the named address space @var{as}. This target\n\
-hook is the same as the @code{TARGET_LEGITIMIZE_ADDRESS} target hook,\n\
+ "Define this to modify an invalid address :samp:`{x}` to be a valid address\n\
+with mode :samp:`{mode}` in the named address space :samp:`{as}`. This target\n\
+hook is the same as the ``TARGET_LEGITIMIZE_ADDRESS`` target hook,\n\
except that it includes explicit named address space support.",
rtx, (rtx x, rtx oldx, machine_mode mode, addr_space_t as),
default_addr_space_legitimize_address)
@@ -3338,8 +3331,8 @@ except that it includes explicit named address space support.",
/* True if one named address space is a subset of another named address. */
DEFHOOK
(subset_p,
- "Define this to return whether the @var{subset} named address space is\n\
-contained within the @var{superset} named address space. Pointers to\n\
+ "Define this to return whether the :samp:`{subset}` named address space is\n\
+contained within the :samp:`{superset}` named address space. Pointers to\n\
a named address space that is a subset of another named address space\n\
will be converted automatically without a cast if used together in\n\
arithmetic operations. Pointers to a superset address space can be\n\
@@ -3360,11 +3353,11 @@ address space. Return true if 0 should be considered a valid address.",
DEFHOOK
(convert,
"Define this to convert the pointer expression represented by the RTL\n\
-@var{op} with type @var{from_type} that points to a named address\n\
-space to a new pointer expression with type @var{to_type} that points\n\
+:samp:`{op}` with type :samp:`{from_type}` that points to a named address\n\
+space to a new pointer expression with type :samp:`{to_type}` that points\n\
to a different named address space. When this hook it called, it is\n\
guaranteed that one of the two address spaces is a subset of the other,\n\
-as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
+as determined by the ``TARGET_ADDR_SPACE_SUBSET_P`` target hook.",
rtx, (rtx op, tree from_type, tree to_type),
default_addr_space_convert)
@@ -3372,7 +3365,7 @@ as determined by the @code{TARGET_ADDR_SPACE_SUBSET_P} target hook.",
DEFHOOK
(debug,
"Define this to define how the address space is encoded in dwarf.\n\
-The result is the value to be used with @code{DW_AT_address_class}.",
+The result is the value to be used with ``DW_AT_address_class``.",
int, (addr_space_t as),
default_addr_space_debug)
@@ -3383,9 +3376,9 @@ DEFHOOK
command line options and some diagnostics should be printed when the\n\
address space is used. This hook is called during parsing and allows\n\
to emit a better diagnostic compared to the case where the address space\n\
-was not registered with @code{c_register_addr_space}. @var{as} is\n\
-the address space as registered with @code{c_register_addr_space}.\n\
-@var{loc} is the location of the address space qualifier token.\n\
+was not registered with ``c_register_addr_space``. :samp:`{as}` is\n\
+the address space as registered with ``c_register_addr_space``.\n\
+:samp:`{loc}` is the location of the address space qualifier token.\n\
The default implementation does nothing.",
void, (addr_space_t as, location_t loc),
default_addr_space_diagnose_usage)
@@ -3398,39 +3391,39 @@ HOOK_VECTOR_END (addr_space)
DEFHOOK
(lower_local_decl_alignment,
"Define this hook to lower alignment of local, parm or result\n\
-decl @samp{(@var{decl})}.",
+decl :samp:`({decl})`.",
void, (tree decl),
hook_void_tree)
DEFHOOK
(static_rtx_alignment,
"This hook returns the preferred alignment in bits for a\n\
-statically-allocated rtx, such as a constant pool entry. @var{mode}\n\
+statically-allocated rtx, such as a constant pool entry. :samp:`{mode}`\n\
is the mode of the rtx. The default implementation returns\n\
-@samp{GET_MODE_ALIGNMENT (@var{mode})}.",
+:samp:`GET_MODE_ALIGNMENT ({mode})`.",
HOST_WIDE_INT, (machine_mode mode),
default_static_rtx_alignment)
DEFHOOK
(constant_alignment,
"This hook returns the alignment in bits of a constant that is being\n\
-placed in memory. @var{constant} is the constant and @var{basic_align}\n\
+placed in memory. :samp:`{constant}` is the constant and :samp:`{basic_align}`\n\
is the alignment that the object would ordinarily have.\n\
\n\
-The default definition just returns @var{basic_align}.\n\
+The default definition just returns :samp:`{basic_align}`.\n\
\n\
The typical use of this hook is to increase alignment for string\n\
-constants to be word aligned so that @code{strcpy} calls that copy\n\
+constants to be word aligned so that ``strcpy`` calls that copy\n\
constants can be done inline. The function\n\
-@code{constant_alignment_word_strings} provides such a definition.",
+``constant_alignment_word_strings`` provides such a definition.",
HOST_WIDE_INT, (const_tree constant, HOST_WIDE_INT basic_align),
default_constant_alignment)
DEFHOOK
(translate_mode_attribute,
"Define this hook if during mode attribute processing, the port should\n\
-translate machine_mode @var{mode} to another mode. For example, rs6000's\n\
-@code{KFmode}, when it is the same as @code{TFmode}.\n\
+translate machine_mode :samp:`{mode}` to another mode. For example, rs6000's\n\
+``KFmode``, when it is the same as ``TFmode``.\n\
\n\
The default version of the hook returns that mode that was passed in.",
machine_mode, (machine_mode mode),
@@ -3442,14 +3435,14 @@ The default version of the hook returns that mode that was passed in.",
DEFHOOK
(scalar_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving scalar mode @var{mode}. For a scalar mode to be\n\
+insns involving scalar mode :samp:`{mode}`. For a scalar mode to be\n\
considered supported, all the basic arithmetic and comparisons\n\
must work.\n\
\n\
The default version of this hook returns true for any mode\n\
required to handle the basic C types (as defined by the port).\n\
Included here are the double-word arithmetic supported by the\n\
-code in @file{optabs.cc}.",
+code in :samp:`optabs.cc`.",
bool, (scalar_mode mode),
default_scalar_mode_supported_p)
@@ -3459,7 +3452,7 @@ code in @file{optabs.cc}.",
DEFHOOK
(vector_mode_supported_p,
"Define this to return nonzero if the port is prepared to handle\n\
-insns involving vector mode @var{mode}. At the very least, it\n\
+insns involving vector mode :samp:`{mode}`. At the very least, it\n\
must have move patterns for this mode.",
bool, (machine_mode mode),
hook_bool_mode_false)
@@ -3467,20 +3460,20 @@ must have move patterns for this mode.",
DEFHOOK
(compatible_vector_types_p,
"Return true if there is no target-specific reason for treating\n\
-vector types @var{type1} and @var{type2} as distinct types. The caller\n\
+vector types :samp:`{type1}` and :samp:`{type2}` as distinct types. The caller\n\
has already checked for target-independent reasons, meaning that the\n\
types are known to have the same mode, to have the same number of elements,\n\
and to have what the caller considers to be compatible element types.\n\
\n\
The main reason for defining this hook is to reject pairs of types\n\
that are handled differently by the target's calling convention.\n\
-For example, when a new @var{N}-bit vector architecture is added\n\
-to a target, the target may want to handle normal @var{N}-bit\n\
-@code{VECTOR_TYPE} arguments and return values in the same way as\n\
+For example, when a new :samp:`{N}` -bit vector architecture is added\n\
+to a target, the target may want to handle normal :samp:`{N}` -bit\n\
+``VECTOR_TYPE`` arguments and return values in the same way as\n\
before, to maintain backwards compatibility. However, it may also\n\
-provide new, architecture-specific @code{VECTOR_TYPE}s that are passed\n\
+provide new, architecture-specific ``VECTOR_TYPE`` s that are passed\n\
and returned in a more efficient way. It is then important to maintain\n\
-a distinction between the ``normal'' @code{VECTOR_TYPE}s and the new\n\
+a distinction between the 'normal' ``VECTOR_TYPE`` s and the new\n\
architecture-specific ones.\n\
\n\
The default implementation returns true, which is correct for most targets.",
@@ -3490,7 +3483,7 @@ The default implementation returns true, which is correct for most targets.",
DEFHOOK
(vector_alignment,
"This hook can be used to define the alignment for a vector of type\n\
-@var{type}, in order to comply with a platform ABI. The default is to\n\
+:samp:`{type}`, in order to comply with a platform ABI. The default is to\n\
require natural alignment for vector types. The alignment returned by\n\
this hook must be a power-of-two multiple of the default alignment of\n\
the vector element type.",
@@ -3500,12 +3493,12 @@ the vector element type.",
DEFHOOK
(array_mode,
"Return the mode that GCC should use for an array that has\n\
-@var{nelems} elements, with each element having mode @var{mode}.\n\
+:samp:`{nelems}` elements, with each element having mode :samp:`{mode}`.\n\
Return no mode if the target has no special requirements. In the\n\
latter case, GCC looks for an integer mode of the appropriate size\n\
if available and uses BLKmode otherwise. Usually the search for the\n\
-integer mode is limited to @code{MAX_FIXED_MODE_SIZE}, but the\n\
-@code{TARGET_ARRAY_MODE_SUPPORTED_P} hook allows a larger mode to be\n\
+integer mode is limited to ``MAX_FIXED_MODE_SIZE``, but the\n\
+``TARGET_ARRAY_MODE_SUPPORTED_P`` hook allows a larger mode to be\n\
used in specific cases.\n\
\n\
The main use of this hook is to specify that an array of vectors should\n\
@@ -3518,73 +3511,73 @@ also have a vector mode. The default implementation returns no mode.",
DEFHOOK
(array_mode_supported_p,
"Return true if GCC should try to use a scalar mode to store an array\n\
-of @var{nelems} elements, given that each element has mode @var{mode}.\n\
-Returning true here overrides the usual @code{MAX_FIXED_MODE} limit\n\
+of :samp:`{nelems}` elements, given that each element has mode :samp:`{mode}`.\n\
+Returning true here overrides the usual ``MAX_FIXED_MODE`` limit\n\
and allows GCC to use any defined integer mode.\n\
\n\
One use of this hook is to support vector load and store operations\n\
that operate on several homogeneous vectors. For example, ARM NEON\n\
has operations like:\n\
\n\
-@smallexample\n\
-int8x8x3_t vld3_s8 (const int8_t *)\n\
-@end smallexample\n\
+.. code-block:: c++\n\
+\n\
+ int8x8x3_t vld3_s8 (const int8_t *)\n\
\n\
where the return type is defined as:\n\
\n\
-@smallexample\n\
-typedef struct int8x8x3_t\n\
-@{\n\
- int8x8_t val[3];\n\
-@} int8x8x3_t;\n\
-@end smallexample\n\
+.. code-block:: c++\n\
\n\
-If this hook allows @code{val} to have a scalar mode, then\n\
-@code{int8x8x3_t} can have the same mode. GCC can then store\n\
-@code{int8x8x3_t}s in registers rather than forcing them onto the stack.",
+ typedef struct int8x8x3_t\n\
+ {\n\
+ int8x8_t val[3];\n\
+ } int8x8x3_t;\n\
+\n\
+If this hook allows ``val`` to have a scalar mode, then\n\
+``int8x8x3_t`` can have the same mode. GCC can then store\n\
+``int8x8x3_t`` s in registers rather than forcing them onto the stack.",
bool, (machine_mode mode, unsigned HOST_WIDE_INT nelems),
hook_bool_mode_uhwi_false)
DEFHOOK
(libgcc_floating_mode_supported_p,
"Define this to return nonzero if libgcc provides support for the \n\
-floating-point mode @var{mode}, which is known to pass \n\
-@code{TARGET_SCALAR_MODE_SUPPORTED_P}. The default version of this \n\
-hook returns true for all of @code{SFmode}, @code{DFmode}, \n\
-@code{XFmode} and @code{TFmode}, if such modes exist.",
+floating-point mode :samp:`{mode}`, which is known to pass \n\
+``TARGET_SCALAR_MODE_SUPPORTED_P``. The default version of this \n\
+hook returns true for all of ``SFmode``, ``DFmode``, \n\
+``XFmode`` and ``TFmode``, if such modes exist.",
bool, (scalar_float_mode mode),
default_libgcc_floating_mode_supported_p)
DEFHOOK
(floatn_mode,
"Define this to return the machine mode to use for the type \n\
-@code{_Float@var{n}}, if @var{extended} is false, or the type \n\
-@code{_Float@var{n}x}, if @var{extended} is true. If such a type is not\n\
-supported, return @code{opt_scalar_float_mode ()}. The default version of\n\
-this hook returns @code{SFmode} for @code{_Float32}, @code{DFmode} for\n\
-@code{_Float64} and @code{_Float32x} and @code{TFmode} for \n\
-@code{_Float128}, if those modes exist and satisfy the requirements for \n\
-those types and pass @code{TARGET_SCALAR_MODE_SUPPORTED_P} and \n\
-@code{TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P}; for @code{_Float64x}, it \n\
-returns the first of @code{XFmode} and @code{TFmode} that exists and \n\
+``_Floatn``, if :samp:`{extended}` is false, or the type \n\
+``_Floatnx``, if :samp:`{extended}` is true. If such a type is not\n\
+supported, return ``opt_scalar_float_mode ()``. The default version of\n\
+this hook returns ``SFmode`` for ``_Float32``, ``DFmode`` for\n\
+``_Float64`` and ``_Float32x`` and ``TFmode`` for \n\
+``_Float128``, if those modes exist and satisfy the requirements for \n\
+those types and pass ``TARGET_SCALAR_MODE_SUPPORTED_P`` and \n\
+``TARGET_LIBGCC_FLOATING_MODE_SUPPORTED_P`` ; for ``_Float64x``, it \n\
+returns the first of ``XFmode`` and ``TFmode`` that exists and \n\
satisfies the same requirements; for other types, it returns \n\
-@code{opt_scalar_float_mode ()}. The hook is only called for values\n\
-of @var{n} and @var{extended} that are valid according to\n\
-ISO/IEC TS 18661-3:2015; that is, @var{n} is one of 32, 64, 128, or,\n\
-if @var{extended} is false, 16 or greater than 128 and a multiple of 32.",
+``opt_scalar_float_mode ()``. The hook is only called for values\n\
+of :samp:`{n}` and :samp:`{extended}` that are valid according to\n\
+ISO/IEC TS 18661-3:2015; that is, :samp:`{n}` is one of 32, 64, 128, or,\n\
+if :samp:`{extended}` is false, 16 or greater than 128 and a multiple of 32.",
opt_scalar_float_mode, (int n, bool extended),
default_floatn_mode)
DEFHOOK
(floatn_builtin_p,
- "Define this to return true if the @code{_Float@var{n}} and\n\
-@code{_Float@var{n}x} built-in functions should implicitly enable the\n\
-built-in function without the @code{__builtin_} prefix in addition to the\n\
-normal built-in function with the @code{__builtin_} prefix. The default is\n\
-to only enable built-in functions without the @code{__builtin_} prefix for\n\
+ "Define this to return true if the ``_Floatn`` and\n\
+``_Floatnx`` built-in functions should implicitly enable the\n\
+built-in function without the ``__builtin_`` prefix in addition to the\n\
+normal built-in function with the ``__builtin_`` prefix. The default is\n\
+to only enable built-in functions without the ``__builtin_`` prefix for\n\
the GNU C langauge. In strict ANSI/ISO mode, the built-in function without\n\
-the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
-@code{enum built_in_function} id of the function to be enabled.",
+the ``__builtin_`` prefix is not enabled. The argument ``FUNC`` is the\n\
+``enum built_in_function`` id of the function to be enabled.",
bool, (int func),
default_floatn_builtin_p)
@@ -3592,22 +3585,22 @@ the @code{__builtin_} prefix is not enabled. The argument @code{FUNC} is the\n\
TO, using MODE. */
DEFHOOK
(register_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-from a register in class @var{from} to one in class @var{to}. The classes\n\
-are expressed using the enumeration values such as @code{GENERAL_REGS}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+from a register in class :samp:`{from}` to one in class :samp:`{to}`. The classes\n\
+are expressed using the enumeration values such as ``GENERAL_REGS``.\n\
A value of 2 is the default; other values are interpreted relative to\n\
that.\n\
\n\
-It is not required that the cost always equal 2 when @var{from} is the\n\
-same as @var{to}; on some machines it is expensive to move between\n\
+It is not required that the cost always equal 2 when :samp:`{from}` is the\n\
+same as :samp:`{to}` ; on some machines it is expensive to move between\n\
registers if they are not general registers.\n\
\n\
-If reload sees an insn consisting of a single @code{set} between two\n\
-hard registers, and if @code{TARGET_REGISTER_MOVE_COST} applied to their\n\
+If reload sees an insn consisting of a single ``set`` between two\n\
+hard registers, and if ``TARGET_REGISTER_MOVE_COST`` applied to their\n\
classes returns a value of 2, reload does not check to ensure that the\n\
constraints of the insn are met. Setting a cost of other than 2 will\n\
allow reload to verify that the constraints are met. You should do this\n\
-if the @samp{mov@var{m}} pattern's constraints do not allow such copying.\n\
+if the :samp:`mov{m}` pattern's constraints do not allow such copying.\n\
\n\
The default version of this function returns 2.",
int, (machine_mode mode, reg_class_t from, reg_class_t to),
@@ -3618,21 +3611,21 @@ The default version of this function returns 2.",
license grant. Also, the documentation uses a different name for RCLASS. */
DEFHOOK
(memory_move_cost,
- "This target hook should return the cost of moving data of mode @var{mode}\n\
-between a register of class @var{rclass} and memory; @var{in} is @code{false}\n\
-if the value is to be written to memory, @code{true} if it is to be read in.\n\
-This cost is relative to those in @code{TARGET_REGISTER_MOVE_COST}.\n\
+ "This target hook should return the cost of moving data of mode :samp:`{mode}`\n\
+between a register of class :samp:`{rclass}` and memory; :samp:`{in}` is ``false``\n\
+if the value is to be written to memory, ``true`` if it is to be read in.\n\
+This cost is relative to those in ``TARGET_REGISTER_MOVE_COST``.\n\
If moving between registers and memory is more expensive than between two\n\
registers, you should add this target hook to express the relative cost.\n\
\n\
If you do not add this target hook, GCC uses a default cost of 4 plus\n\
the cost of copying via a secondary reload register, if one is\n\
needed. If your machine requires a secondary reload register to copy\n\
-between memory and a register of @var{rclass} but the reload mechanism is\n\
+between memory and a register of :samp:`{rclass}` but the reload mechanism is\n\
more complex than copying via an intermediate, use this target hook to\n\
reflect the actual cost of the move.\n\
\n\
-GCC defines the function @code{memory_move_secondary_cost} if\n\
+GCC defines the function ``memory_move_secondary_cost`` if\n\
secondary reloads are needed. It computes the costs due to copying via\n\
a secondary register. If your machine copies from memory using a\n\
secondary register in the conventional way but the default base value of\n\
@@ -3646,34 +3639,34 @@ DEFHOOK
(use_by_pieces_infrastructure_p,
"GCC will attempt several strategies when asked to copy between\n\
two areas of memory, or to set, clear or store to memory, for example\n\
-when copying a @code{struct}. The @code{by_pieces} infrastructure\n\
+when copying a ``struct``. The ``by_pieces`` infrastructure\n\
implements such memory operations as a sequence of load, store or move\n\
insns. Alternate strategies are to expand the\n\
-@code{cpymem} or @code{setmem} optabs, to emit a library call, or to emit\n\
+``cpymem`` or ``setmem`` optabs, to emit a library call, or to emit\n\
unit-by-unit, loop-based operations.\n\
\n\
This target hook should return true if, for a memory operation with a\n\
-given @var{size} and @var{alignment}, using the @code{by_pieces}\n\
+given :samp:`{size}` and :samp:`{alignment}`, using the ``by_pieces``\n\
infrastructure is expected to result in better code generation.\n\
-Both @var{size} and @var{alignment} are measured in terms of storage\n\
+Both :samp:`{size}` and :samp:`{alignment}` are measured in terms of storage\n\
units.\n\
\n\
-The parameter @var{op} is one of: @code{CLEAR_BY_PIECES},\n\
-@code{MOVE_BY_PIECES}, @code{SET_BY_PIECES}, @code{STORE_BY_PIECES} or\n\
-@code{COMPARE_BY_PIECES}. These describe the type of memory operation\n\
+The parameter :samp:`{op}` is one of: ``CLEAR_BY_PIECES``,\n\
+``MOVE_BY_PIECES``, ``SET_BY_PIECES``, ``STORE_BY_PIECES`` or\n\
+``COMPARE_BY_PIECES``. These describe the type of memory operation\n\
under consideration.\n\
\n\
-The parameter @var{speed_p} is true if the code is currently being\n\
+The parameter :samp:`{speed_p}` is true if the code is currently being\n\
optimized for speed rather than size.\n\
\n\
-Returning true for higher values of @var{size} can improve code generation\n\
+Returning true for higher values of :samp:`{size}` can improve code generation\n\
for speed if the target does not provide an implementation of the\n\
-@code{cpymem} or @code{setmem} standard names, if the @code{cpymem} or\n\
-@code{setmem} implementation would be more expensive than a sequence of\n\
+``cpymem`` or ``setmem`` standard names, if the ``cpymem`` or\n\
+``setmem`` implementation would be more expensive than a sequence of\n\
insns, or if the overhead of a library call would dominate that of\n\
the body of the memory operation.\n\
\n\
-Returning true for higher values of @code{size} may also cause an increase\n\
+Returning true for higher values of ``size`` may also cause an increase\n\
in code size, for example where the number of insns emitted to perform a\n\
move would be greater than that of a library call.",
bool, (unsigned HOST_WIDE_INT size, unsigned int alignment,
@@ -3682,7 +3675,7 @@ move would be greater than that of a library call.",
DEFHOOK
(overlap_op_by_pieces_p,
- "This target hook should return true if when the @code{by_pieces}\n\
+ "This target hook should return true if when the ``by_pieces``\n\
infrastructure is used, an offset adjusted unaligned memory operation\n\
in the smallest integer mode for the last piece operation of a memory\n\
region can be generated to avoid doing more than one smaller operations.",
@@ -3695,7 +3688,7 @@ DEFHOOK
number of branches at the expense of more memory operations. This hook\n\
allows the target to override the default choice. It should return the\n\
factor by which branches should be reduced over the plain expansion with\n\
-one comparison per @var{mode}-sized piece. A port can also prevent a\n\
+one comparison per :samp:`{mode}` -sized piece. A port can also prevent a\n\
particular mode from being used for block comparisons by returning a\n\
negative number from this hook.",
int, (machine_mode mode),
@@ -3704,33 +3697,33 @@ negative number from this hook.",
DEFHOOK
(slow_unaligned_access,
"This hook returns true if memory accesses described by the\n\
-@var{mode} and @var{alignment} parameters have a cost many times greater\n\
+:samp:`{mode}` and :samp:`{alignment}` parameters have a cost many times greater\n\
than aligned accesses, for example if they are emulated in a trap handler.\n\
-This hook is invoked only for unaligned accesses, i.e.@: when\n\
-@code{@var{alignment} < GET_MODE_ALIGNMENT (@var{mode})}.\n\
+This hook is invoked only for unaligned accesses, i.e. when\n\
+``alignment < GET_MODE_ALIGNMENT (mode)``.\n\
\n\
When this hook returns true, the compiler will act as if\n\
-@code{STRICT_ALIGNMENT} were true when generating code for block\n\
+``STRICT_ALIGNMENT`` were true when generating code for block\n\
moves. This can cause significantly more instructions to be produced.\n\
Therefore, do not make this hook return true if unaligned accesses only\n\
add a cycle or two to the time for a memory access.\n\
\n\
-The hook must return true whenever @code{STRICT_ALIGNMENT} is true.\n\
-The default implementation returns @code{STRICT_ALIGNMENT}.",
+The hook must return true whenever ``STRICT_ALIGNMENT`` is true.\n\
+The default implementation returns ``STRICT_ALIGNMENT``.",
bool, (machine_mode mode, unsigned int align),
default_slow_unaligned_access)
DEFHOOK
(optab_supported_p,
- "Return true if the optimizers should use optab @var{op} with\n\
-modes @var{mode1} and @var{mode2} for optimization type @var{opt_type}.\n\
-The optab is known to have an associated @file{.md} instruction\n\
-whose C condition is true. @var{mode2} is only meaningful for conversion\n\
-optabs; for direct optabs it is a copy of @var{mode1}.\n\
+ "Return true if the optimizers should use optab :samp:`{op}` with\n\
+modes :samp:`{mode1}` and :samp:`{mode2}` for optimization type :samp:`{opt_type}`.\n\
+The optab is known to have an associated :samp:`.md` instruction\n\
+whose C condition is true. :samp:`{mode2}` is only meaningful for conversion\n\
+optabs; for direct optabs it is a copy of :samp:`{mode1}`.\n\
\n\
-For example, when called with @var{op} equal to @code{rint_optab} and\n\
-@var{mode1} equal to @code{DFmode}, the hook should say whether the\n\
-optimizers should use optab @code{rintdf2}.\n\
+For example, when called with :samp:`{op}` equal to ``rint_optab`` and\n\
+:samp:`{mode1}` equal to ``DFmode``, the hook should say whether the\n\
+optimizers should use optab ``rintdf2``.\n\
\n\
The default hook returns true for all inputs.",
bool, (int op, machine_mode mode1, machine_mode mode2,
@@ -3745,8 +3738,8 @@ DEFHOOK
(small_register_classes_for_mode_p,
"Define this to return nonzero for machine modes for which the port has\n\
small register classes. If this target hook returns nonzero for a given\n\
-@var{mode}, the compiler will try to minimize the lifetime of registers\n\
-in @var{mode}. The hook may be called with @code{VOIDmode} as argument.\n\
+:samp:`{mode}`, the compiler will try to minimize the lifetime of registers\n\
+in :samp:`{mode}`. The hook may be called with ``VOIDmode`` as argument.\n\
In this case, the hook is expected to return nonzero if it returns nonzero\n\
for any mode.\n\
\n\
@@ -3763,7 +3756,7 @@ classes are small for, say, integer registers but not for floating point\n\
registers. For example, the AMD x86-64 architecture requires specific\n\
registers for the legacy x86 integer instructions, but there are many\n\
SSE registers for floating point operations. On such targets, a good\n\
-strategy may be to return nonzero from this hook for @code{INTEGRAL_MODE_P}\n\
+strategy may be to return nonzero from this hook for ``INTEGRAL_MODE_P``\n\
machine modes but zero for the SSE register classes.\n\
\n\
The default version of this hook returns false for any mode. It is always\n\
@@ -3794,32 +3787,32 @@ DEFHOOK
"This target hook describes the relative costs of RTL expressions.\n\
\n\
The cost may depend on the precise form of the expression, which is\n\
-available for examination in @var{x}, and the fact that @var{x} appears\n\
-as operand @var{opno} of an expression with rtx code @var{outer_code}.\n\
-That is, the hook can assume that there is some rtx @var{y} such\n\
-that @samp{GET_CODE (@var{y}) == @var{outer_code}} and such that\n\
-either (a) @samp{XEXP (@var{y}, @var{opno}) == @var{x}} or\n\
-(b) @samp{XVEC (@var{y}, @var{opno})} contains @var{x}.\n\
+available for examination in :samp:`{x}`, and the fact that :samp:`{x}` appears\n\
+as operand :samp:`{opno}` of an expression with rtx code :samp:`{outer_code}`.\n\
+That is, the hook can assume that there is some rtx :samp:`{y}` such\n\
+that :samp:`GET_CODE ({y}) == {outer_code}` and such that\n\
+either (a) :samp:`XEXP ({y}, {opno}) == {x}` or\n\
+(b) :samp:`XVEC ({y}, {opno})` contains :samp:`{x}`.\n\
\n\
-@var{mode} is @var{x}'s machine mode, or for cases like @code{const_int} that\n\
-do not have a mode, the mode in which @var{x} is used.\n\
+:samp:`{mode}` is :samp:`{x}` 's machine mode, or for cases like ``const_int`` that\n\
+do not have a mode, the mode in which :samp:`{x}` is used.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-On entry to the hook, @code{*@var{total}} contains a default estimate\n\
+On entry to the hook, ``*total`` contains a default estimate\n\
for the cost of the expression. The hook should modify this value as\n\
-necessary. Traditionally, the default costs are @code{COSTS_N_INSNS (5)}\n\
-for multiplications, @code{COSTS_N_INSNS (7)} for division and modulus\n\
-operations, and @code{COSTS_N_INSNS (1)} for all other operations.\n\
+necessary. Traditionally, the default costs are ``COSTS_N_INSNS (5)``\n\
+for multiplications, ``COSTS_N_INSNS (7)`` for division and modulus\n\
+operations, and ``COSTS_N_INSNS (1)`` for all other operations.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.\n\
+size cost of an expression, again relative to ``COSTS_N_INSNS``.\n\
\n\
-The hook returns true when all subexpressions of @var{x} have been\n\
-processed, and false when @code{rtx_cost} should recurse.",
+The hook returns true when all subexpressions of :samp:`{x}` have been\n\
+processed, and false when ``rtx_cost`` should recurse.",
bool, (rtx x, machine_mode mode, int outer_code, int opno, int *total, bool speed),
hook_bool_rtx_mode_int_int_intp_bool_false)
@@ -3828,8 +3821,8 @@ processed, and false when @code{rtx_cost} should recurse.",
DEFHOOK
(address_cost,
"This hook computes the cost of an addressing mode that contains\n\
-@var{address}. If not defined, the cost is computed from\n\
-the @var{address} expression and the @code{TARGET_RTX_COST} hook.\n\
+:samp:`{address}`. If not defined, the cost is computed from\n\
+the :samp:`{address}` expression and the ``TARGET_RTX_COST`` hook.\n\
\n\
For most CISC machines, the default cost is a good approximation of the\n\
true cost of the addressing mode. However, on RISC machines, all\n\
@@ -3853,9 +3846,9 @@ This hook is never called with an invalid address.\n\
\n\
On machines where an address involving more than one register is as\n\
cheap as an address computation involving only one register, defining\n\
-@code{TARGET_ADDRESS_COST} to reflect this can cause two registers to\n\
+``TARGET_ADDRESS_COST`` to reflect this can cause two registers to\n\
be live over a region of code where only one would have been if\n\
-@code{TARGET_ADDRESS_COST} were not defined in that manner. This effect\n\
+``TARGET_ADDRESS_COST`` were not defined in that manner. This effect\n\
should be considered in the definition of this macro. Equivalent costs\n\
should probably only be given to addresses with different numbers of\n\
registers on machines with lots of registers.",
@@ -3868,35 +3861,35 @@ DEFHOOK
"This target hook describes the relative costs of RTL instructions.\n\
\n\
In implementing this hook, you can use the construct\n\
-@code{COSTS_N_INSNS (@var{n})} to specify a cost equal to @var{n} fast\n\
+``COSTS_N_INSNS (n)`` to specify a cost equal to :samp:`{n}` fast\n\
instructions.\n\
\n\
-When optimizing for code size, i.e.@: when @code{speed} is\n\
+When optimizing for code size, i.e. when ``speed`` is\n\
false, this target hook should be used to estimate the relative\n\
-size cost of an expression, again relative to @code{COSTS_N_INSNS}.",
+size cost of an expression, again relative to ``COSTS_N_INSNS``.",
int, (rtx_insn *insn, bool speed), NULL)
/* Give a cost, in RTX Costs units, for an edge. Like BRANCH_COST, but with
well defined units. */
DEFHOOK
(max_noce_ifcvt_seq_cost,
- "This hook returns a value in the same units as @code{TARGET_RTX_COSTS},\n\
+ "This hook returns a value in the same units as ``TARGET_RTX_COSTS``,\n\
giving the maximum acceptable cost for a sequence generated by the RTL\n\
if-conversion pass when conditional execution is not available.\n\
The RTL if-conversion pass attempts to convert conditional operations\n\
that would require a branch to a series of unconditional operations and\n\
-@code{mov@var{mode}cc} insns. This hook returns the maximum cost of the\n\
-unconditional instructions and the @code{mov@var{mode}cc} insns.\n\
+``movmodecc`` insns. This hook returns the maximum cost of the\n\
+unconditional instructions and the ``movmodecc`` insns.\n\
RTL if-conversion is cancelled if the cost of the converted sequence\n\
is greater than the value returned by this hook.\n\
\n\
-@code{e} is the edge between the basic block containing the conditional\n\
+``e`` is the edge between the basic block containing the conditional\n\
branch to the basic block which would be executed if the condition\n\
were true.\n\
\n\
The default implementation of this hook uses the\n\
-@code{max-rtl-if-conversion-[un]predictable} parameters if they are set,\n\
-and uses a multiple of @code{BRANCH_COST} otherwise.",
+``max-rtl-if-conversion-[un]predictable`` parameters if they are set,\n\
+and uses a multiple of ``BRANCH_COST`` otherwise.",
unsigned int, (edge e),
default_max_noce_ifcvt_seq_cost)
@@ -3904,9 +3897,9 @@ default_max_noce_ifcvt_seq_cost)
as a replacement for the if-convertible sequence. */
DEFHOOK
(noce_conversion_profitable_p,
- "This hook returns true if the instruction sequence @code{seq} is a good\n\
+ "This hook returns true if the instruction sequence ``seq`` is a good\n\
candidate as a replacement for the if-convertible sequence described in\n\
-@code{if_info}.",
+``if_info``.",
bool, (rtx_insn *seq, struct noce_if_info *if_info),
default_noce_conversion_profitable_p)
@@ -3914,21 +3907,21 @@ default_noce_conversion_profitable_p)
memref in insn. */
DEFHOOK
(new_address_profitable_p,
- "Return @code{true} if it is profitable to replace the address in\n\
-@var{memref} with @var{new_addr}. This allows targets to prevent the\n\
+ "Return ``true`` if it is profitable to replace the address in\n\
+:samp:`{memref}` with :samp:`{new_addr}`. This allows targets to prevent the\n\
scheduler from undoing address optimizations. The instruction containing the\n\
-memref is @var{insn}. The default implementation returns @code{true}.",
+memref is :samp:`{insn}`. The default implementation returns ``true``.",
bool, (rtx memref, rtx_insn * insn, rtx new_addr),
default_new_address_profitable_p)
DEFHOOK
(estimated_poly_value,
- "Return an estimate of the runtime value of @var{val}, for use in\n\
-things like cost calculations or profiling frequencies. @var{kind} is used\n\
+ "Return an estimate of the runtime value of :samp:`{val}`, for use in\n\
+things like cost calculations or profiling frequencies. :samp:`{kind}` is used\n\
to ask for the minimum, maximum, and likely estimates of the value through\n\
-the @code{POLY_VALUE_MIN}, @code{POLY_VALUE_MAX} and\n\
-@code{POLY_VALUE_LIKELY} values. The default\n\
-implementation returns the lowest possible value of @var{val}.",
+the ``POLY_VALUE_MIN``, ``POLY_VALUE_MAX`` and\n\
+``POLY_VALUE_LIKELY`` values. The default\n\
+implementation returns the lowest possible value of :samp:`{val}`.",
HOST_WIDE_INT, (poly_int64 val, poly_value_estimate_kind kind),
default_estimated_poly_value)
@@ -3949,24 +3942,23 @@ as the delay slot can hide a pipeline bubble.",
/* Return where to allocate pseudo for a given hard register initial value. */
DEFHOOK
(allocate_initial_value,
- "\n\
-When the initial value of a hard register has been copied in a pseudo\n\
+ "When the initial value of a hard register has been copied in a pseudo\n\
register, it is often not necessary to actually allocate another register\n\
to this pseudo register, because the original hard register or a stack slot\n\
-it has been saved into can be used. @code{TARGET_ALLOCATE_INITIAL_VALUE}\n\
+it has been saved into can be used. ``TARGET_ALLOCATE_INITIAL_VALUE``\n\
is called at the start of register allocation once for each hard register\n\
that had its initial value copied by using\n\
-@code{get_func_hard_reg_initial_val} or @code{get_hard_reg_initial_val}.\n\
-Possible values are @code{NULL_RTX}, if you don't want\n\
-to do any special allocation, a @code{REG} rtx---that would typically be\n\
+``get_func_hard_reg_initial_val`` or ``get_hard_reg_initial_val``.\n\
+Possible values are ``NULL_RTX``, if you don't want\n\
+to do any special allocation, a ``REG`` rtx---that would typically be\n\
the hard register itself, if it is known not to be clobbered---or a\n\
-@code{MEM}.\n\
-If you are returning a @code{MEM}, this is only a hint for the allocator;\n\
+``MEM``.\n\
+If you are returning a ``MEM``, this is only a hint for the allocator;\n\
it might decide to use another register anyways.\n\
-You may use @code{current_function_is_leaf} or \n\
-@code{REG_N_SETS} in the hook to determine if the hard\n\
+You may use ``current_function_is_leaf`` or \n\
+``REG_N_SETS`` in the hook to determine if the hard\n\
register in question will not be clobbered.\n\
-The default value of this hook is @code{NULL}, which disables any special\n\
+The default value of this hook is ``NULL``, which disables any special\n\
allocation.",
rtx, (rtx hard_reg), NULL)
@@ -3974,11 +3966,11 @@ allocation.",
FLAGS has the same meaning as in rtlanal.cc: may_trap_p_1. */
DEFHOOK
(unspec_may_trap_p,
- "This target hook returns nonzero if @var{x}, an @code{unspec} or\n\
-@code{unspec_volatile} operation, might cause a trap. Targets can use\n\
-this hook to enhance precision of analysis for @code{unspec} and\n\
-@code{unspec_volatile} operations. You may call @code{may_trap_p_1}\n\
-to analyze inner elements of @var{x} in which case @var{flags} should be\n\
+ "This target hook returns nonzero if :samp:`{x}`, an ``unspec`` or\n\
+``unspec_volatile`` operation, might cause a trap. Targets can use\n\
+this hook to enhance precision of analysis for ``unspec`` and\n\
+``unspec_volatile`` operations. You may call ``may_trap_p_1``\n\
+to analyze inner elements of :samp:`{x}` in which case :samp:`{flags}` should be\n\
passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)
@@ -3995,8 +3987,8 @@ DEFHOOK
represent where to find the register pieces. Define this hook if the\n\
register and its mode are represented in Dwarf in non-contiguous\n\
locations, or if the register should be represented in more than one\n\
-register in Dwarf. Otherwise, this hook should return @code{NULL_RTX}.\n\
-If not defined, the default is to return @code{NULL_RTX}.",
+register in Dwarf. Otherwise, this hook should return ``NULL_RTX``.\n\
+If not defined, the default is to return ``NULL_RTX``.",
rtx, (rtx reg),
hook_rtx_rtx_null)
@@ -4020,9 +4012,9 @@ DEFHOOK
"If some registers are represented in Dwarf-2 unwind information in\n\
multiple pieces, define this hook to fill in information about the\n\
sizes of those pieces in the table used by the unwinder at runtime.\n\
-It will be called by @code{expand_builtin_init_dwarf_reg_sizes} after\n\
+It will be called by ``expand_builtin_init_dwarf_reg_sizes`` after\n\
filling in a single size corresponding to each hard register;\n\
-@var{address} is the address of the table.",
+:samp:`{address}` is the address of the table.",
void, (tree address),
hook_void_tree)
@@ -4043,8 +4035,8 @@ small pass which optimizes such cases. This hook should return true\n\
to enable this pass, and it should set the integers to which its\n\
arguments point to the hard register numbers used for condition codes.\n\
When there is only one such register, as is true on most systems, the\n\
-integer pointed to by @var{p2} should be set to\n\
-@code{INVALID_REGNUM}.\n\
+integer pointed to by :samp:`{p2}` should be set to\n\
+``INVALID_REGNUM``.\n\
\n\
The default version of this hook returns false.",
bool, (unsigned int *p1, unsigned int *p2),
@@ -4058,15 +4050,15 @@ The default version of this hook returns false.",
DEFHOOK
(cc_modes_compatible,
"On targets which use multiple condition code modes in class\n\
-@code{MODE_CC}, it is sometimes the case that a comparison can be\n\
+``MODE_CC``, it is sometimes the case that a comparison can be\n\
validly done in more than one mode. On such a system, define this\n\
target hook to take two mode arguments and to return a mode in which\n\
both comparisons may be validly done. If there is no such mode,\n\
-return @code{VOIDmode}.\n\
+return ``VOIDmode``.\n\
\n\
The default version of this hook checks whether the modes are the\n\
same. If they are, it returns that mode. If they are different, it\n\
-returns @code{VOIDmode}.",
+returns ``VOIDmode``.",
machine_mode, (machine_mode m1, machine_mode m2),
default_cc_modes_compatible)
@@ -4090,24 +4082,24 @@ definition is null.",
/* Create the __builtin_va_list type. */
DEFHOOK
(build_builtin_va_list,
- "This hook returns a type node for @code{va_list} for the target.\n\
-The default version of the hook returns @code{void*}.",
+ "This hook returns a type node for ``va_list`` for the target.\n\
+The default version of the hook returns ``void*``.",
tree, (void),
std_build_builtin_va_list)
/* Enumerate the va list variants. */
DEFHOOK
(enum_va_list_p,
- "This target hook is used in function @code{c_common_nodes_and_builtins}\n\
+ "This target hook is used in function ``c_common_nodes_and_builtins``\n\
to iterate through the target specific builtin types for va_list. The\n\
-variable @var{idx} is used as iterator. @var{pname} has to be a pointer\n\
-to a @code{const char *} and @var{ptree} a pointer to a @code{tree} typed\n\
+variable :samp:`{idx}` is used as iterator. :samp:`{pname}` has to be a pointer\n\
+to a ``const char *`` and :samp:`{ptree}` a pointer to a ``tree`` typed\n\
variable.\n\
-The arguments @var{pname} and @var{ptree} are used to store the result of\n\
+The arguments :samp:`{pname}` and :samp:`{ptree}` are used to store the result of\n\
this macro and are set to the name of the va_list builtin type and its\n\
internal type.\n\
If the return value of this macro is zero, then there is no more element.\n\
-Otherwise the @var{IDX} should be increased for the next call of this\n\
+Otherwise the :samp:`{IDX}` should be increased for the next call of this\n\
macro to iterate through all types.",
int, (int idx, const char **pname, tree *ptree),
NULL)
@@ -4116,8 +4108,8 @@ macro to iterate through all types.",
DEFHOOK
(fn_abi_va_list,
"This hook returns the va_list type of the calling convention specified by\n\
-@var{fndecl}.\n\
-The default version of this hook returns @code{va_list_type_node}.",
+:samp:`{fndecl}`.\n\
+The default version of this hook returns ``va_list_type_node``.",
tree, (tree fndecl),
std_fn_abi_va_list)
@@ -4125,8 +4117,8 @@ The default version of this hook returns @code{va_list_type_node}.",
DEFHOOK
(canonical_va_list_type,
"This hook returns the va_list type of the calling convention specified by the\n\
-type of @var{type}. If @var{type} is not a valid va_list type, it returns\n\
-@code{NULL_TREE}.",
+type of :samp:`{type}`. If :samp:`{type}` is not a valid va_list type, it returns\n\
+``NULL_TREE``.",
tree, (tree type),
std_canonical_va_list_type)
@@ -4140,9 +4132,9 @@ DEFHOOK_UNDOC
DEFHOOK
(gimplify_va_arg_expr,
"This hook performs target-specific gimplification of\n\
-@code{VA_ARG_EXPR}. The first two parameters correspond to the\n\
-arguments to @code{va_arg}; the latter two are as in\n\
-@code{gimplify.cc:gimplify_expr}.",
+``VA_ARG_EXPR``. The first two parameters correspond to the\n\
+arguments to ``va_arg`` ; the latter two are as in\n\
+``gimplify.cc:gimplify_expr``.",
tree, (tree valist, tree type, gimple_seq *pre_p, gimple_seq *post_p),
std_gimplify_va_arg_expr)
@@ -4154,24 +4146,24 @@ arguments to @code{va_arg}; the latter two are as in\n\
DEFHOOK
(get_pch_validity,
"This hook returns a pointer to the data needed by\n\
-@code{TARGET_PCH_VALID_P} and sets\n\
-@samp{*@var{sz}} to the size of the data in bytes.",
+``TARGET_PCH_VALID_P`` and sets\n\
+:samp:`*{sz}` to the size of the data in bytes.",
void *, (size_t *sz),
default_get_pch_validity)
DEFHOOK
(pch_valid_p,
"This hook checks whether the options used to create a PCH file are\n\
-compatible with the current settings. It returns @code{NULL}\n\
+compatible with the current settings. It returns ``NULL``\n\
if so and a suitable error message if not. Error messages will\n\
-be presented to the user and must be localized using @samp{_(@var{msg})}.\n\
+be presented to the user and must be localized using :samp:`_({msg})`.\n\
\n\
-@var{data} is the data that was returned by @code{TARGET_GET_PCH_VALIDITY}\n\
-when the PCH file was created and @var{sz} is the size of that data in bytes.\n\
+:samp:`{data}` is the data that was returned by ``TARGET_GET_PCH_VALIDITY``\n\
+when the PCH file was created and :samp:`{sz}` is the size of that data in bytes.\n\
It's safe to assume that the data was created by the same version of the\n\
compiler, so no format checking is needed.\n\
\n\
-The default definition of @code{default_pch_valid_p} should be\n\
+The default definition of ``default_pch_valid_p`` should be\n\
suitable for most targets.",
const char *, (const void *data, size_t sz),
default_pch_valid_p)
@@ -4191,10 +4183,10 @@ to do anything here.",
DEFHOOK
(check_pch_target_flags,
"If this hook is nonnull, the default implementation of\n\
-@code{TARGET_PCH_VALID_P} will use it to check for compatible values\n\
-of @code{target_flags}. @var{pch_flags} specifies the value that\n\
-@code{target_flags} had when the PCH file was created. The return\n\
-value is the same as for @code{TARGET_PCH_VALID_P}.",
+``TARGET_PCH_VALID_P`` will use it to check for compatible values\n\
+of ``target_flags``. :samp:`{pch_flags}` specifies the value that\n\
+``target_flags`` had when the PCH file was created. The return\n\
+value is the same as for ``TARGET_PCH_VALID_P``.",
const char *, (int pch_flags), NULL)
/* True if the compiler should give an enum type only as many
@@ -4203,9 +4195,9 @@ value is the same as for @code{TARGET_PCH_VALID_P}.",
DEFHOOK
(default_short_enums,
"This target hook should return true if the compiler should give an\n\
-@code{enum} type only as many bytes as it takes to represent the range\n\
+``enum`` type only as many bytes as it takes to represent the range\n\
of possible values of that type. It should return false if all\n\
-@code{enum} types should be allocated like @code{int}.\n\
+``enum`` types should be allocated like ``int``.\n\
\n\
The default is to return false.",
bool, (void),
@@ -4216,10 +4208,10 @@ The default is to return false.",
DEFHOOK
(builtin_setjmp_frame_value,
"This target hook should return an rtx that is used to store\n\
-the address of the current frame into the built in @code{setjmp} buffer.\n\
-The default value, @code{virtual_stack_vars_rtx}, is correct for most\n\
+the address of the current frame into the built in ``setjmp`` buffer.\n\
+The default value, ``virtual_stack_vars_rtx``, is correct for most\n\
machines. One reason you may need to define this target hook is if\n\
-@code{hard_frame_pointer_rtx} is the appropriate value on your machine.",
+``hard_frame_pointer_rtx`` is the appropriate value on your machine.",
rtx, (void),
default_builtin_setjmp_frame_value)
@@ -4227,17 +4219,17 @@ machines. One reason you may need to define this target hook is if\n\
and clobbers the port wishes for pre-processing the asm. */
DEFHOOK
(md_asm_adjust,
- "This target hook may add @dfn{clobbers} to @var{clobbers} and\n\
-@var{clobbered_regs} for any hard regs the port wishes to automatically\n\
-clobber for an asm. The @var{outputs} and @var{inputs} may be inspected\n\
-to avoid clobbering a register that is already used by the asm. @var{loc}\n\
+ "This target hook may add :dfn:`clobbers` to :samp:`{clobbers}` and\n\
+:samp:`{clobbered_regs}` for any hard regs the port wishes to automatically\n\
+clobber for an asm. The :samp:`{outputs}` and :samp:`{inputs}` may be inspected\n\
+to avoid clobbering a register that is already used by the asm. :samp:`{loc}`\n\
is the source location of the asm.\n\
\n\
-It may modify the @var{outputs}, @var{inputs}, @var{input_modes}, and\n\
-@var{constraints} as necessary for other pre-processing. In this case the\n\
+It may modify the :samp:`{outputs}`, :samp:`{inputs}`, :samp:`{input_modes}`, and\n\
+:samp:`{constraints}` as necessary for other pre-processing. In this case the\n\
return value is a sequence of insns to emit after the asm. Note that\n\
-changes to @var{inputs} must be accompanied by the corresponding changes\n\
-to @var{input_modes}.",
+changes to :samp:`{inputs}` must be accompanied by the corresponding changes\n\
+to :samp:`{input_modes}`.",
rtx_insn *,
(vec<rtx>& outputs, vec<rtx>& inputs, vec<machine_mode>& input_modes,
vec<const char *>& constraints, vec<rtx>& clobbers,
@@ -4251,9 +4243,9 @@ to @var{input_modes}.",
the function is being declared as an int. */
DEFHOOK
(dwarf_calling_convention,
- "Define this to enable the dwarf attribute @code{DW_AT_calling_convention} to\n\
-be emitted for each function. Instead of an integer return the enum\n\
-value for the @code{DW_CC_} tag.",
+ " Define this to enable the dwarf attribute ``DW_AT_calling_convention`` to\n\
+ be emitted for each function. Instead of an integer return the enum\n\
+ value for the ``DW_CC_`` tag.",
int, (const_tree function),
hook_int_const_tree_0)
@@ -4269,30 +4261,35 @@ DEFHOOK
"This target hook allows the backend to emit frame-related insns that\n\
contain UNSPECs or UNSPEC_VOLATILEs. The DWARF 2 call frame debugging\n\
info engine will invoke it on insns of the form\n\
-@smallexample\n\
-(set (reg) (unspec [@dots{}] UNSPEC_INDEX))\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec [...] UNSPEC_INDEX))\n\
+\n\
and\n\
-@smallexample\n\
-(set (reg) (unspec_volatile [@dots{}] UNSPECV_INDEX)).\n\
-@end smallexample\n\
-to let the backend emit the call frame instructions. @var{label} is\n\
-the CFI label attached to the insn, @var{pattern} is the pattern of\n\
-the insn and @var{index} is @code{UNSPEC_INDEX} or @code{UNSPECV_INDEX}.",
+\n\
+.. code-block:: c++\n\
+\n\
+ (set (reg) (unspec_volatile [...] UNSPECV_INDEX)).\n\
+\n\
+to let the backend emit the call frame instructions. :samp:`{label}` is\n\
+the CFI label attached to the insn, :samp:`{pattern}` is the pattern of\n\
+the insn and :samp:`{index}` is ``UNSPEC_INDEX`` or ``UNSPECV_INDEX``.",
void, (const char *label, rtx pattern, int index), NULL)
DEFHOOK
(dwarf_poly_indeterminate_value,
- "Express the value of @code{poly_int} indeterminate @var{i} as a DWARF\n\
-expression, with @var{i} counting from 1. Return the number of a DWARF\n\
-register @var{R} and set @samp{*@var{factor}} and @samp{*@var{offset}} such\n\
+ "Express the value of ``poly_int`` indeterminate :samp:`{i}` as a DWARF\n\
+expression, with :samp:`{i}` counting from 1. Return the number of a DWARF\n\
+register :samp:`{R}` and set :samp:`*{factor}` and :samp:`*{offset}` such\n\
that the value of the indeterminate is:\n\
-@smallexample\n\
-value_of(@var{R}) / @var{factor} - @var{offset}\n\
-@end smallexample\n\
+\n\
+.. code-block:: c++\n\
+\n\
+ value_of(R) / factor - offset\n\
\n\
A target only needs to define this hook if it sets\n\
-@samp{NUM_POLY_INT_COEFFS} to a value greater than 1.",
+:samp:`NUM_POLY_INT_COEFFS` to a value greater than 1.",
unsigned int, (unsigned int i, unsigned int *factor, int *offset),
default_dwarf_poly_indeterminate_value)
@@ -4309,14 +4306,14 @@ DEFHOOK_UNDOC
protection guard variable. The type of this DECL is ptr_type_node. */
DEFHOOK
(stack_protect_guard,
- "This hook returns a @code{DECL} node for the external variable to use\n\
+ "This hook returns a ``DECL`` node for the external variable to use\n\
for the stack protection guard. This variable is initialized by the\n\
runtime to some random value and is used to initialize the guard value\n\
that is placed at the top of the local stack frame. The type of this\n\
-variable must be @code{ptr_type_node}.\n\
+variable must be ``ptr_type_node``.\n\
\n\
The default version of this hook creates a variable called\n\
-@samp{__stack_chk_guard}, which is normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_guard`, which is normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_stack_protect_guard)
@@ -4324,13 +4321,13 @@ The default version of this hook creates a variable called\n\
that is invoked when a check vs the guard variable fails. */
DEFHOOK
(stack_protect_fail,
- "This hook returns a @code{CALL_EXPR} that alerts the runtime that the\n\
+ "This hook returns a ``CALL_EXPR`` that alerts the runtime that the\n\
stack protect guard variable has been modified. This expression should\n\
-involve a call to a @code{noreturn} function.\n\
+involve a call to a ``noreturn`` function.\n\
\n\
The default version of this hook invokes a function called\n\
-@samp{__stack_chk_fail}, taking no arguments. This function is\n\
-normally defined in @file{libgcc2.c}.",
+:samp:`__stack_chk_fail`, taking no arguments. This function is\n\
+normally defined in :samp:`libgcc2.c`.",
tree, (void),
default_external_stack_protect_fail)
@@ -4345,47 +4342,47 @@ otherwise return false. The default implementation always returns true.",
DEFHOOK
(have_speculation_safe_value,
-"This hook is used to determine the level of target support for\n\
- @code{__builtin_speculation_safe_value}. If called with an argument\n\
- of false, it returns true if the target has been modified to support\n\
- this builtin. If called with an argument of true, it returns true\n\
- if the target requires active mitigation execution might be speculative.\n\
- \n\
- The default implementation returns false if the target does not define\n\
- a pattern named @code{speculation_barrier}. Else it returns true\n\
- for the first case and whether the pattern is enabled for the current\n\
- compilation for the second case.\n\
- \n\
- For targets that have no processors that can execute instructions\n\
- speculatively an alternative implemenation of this hook is available:\n\
- simply redefine this hook to @code{speculation_safe_value_not_needed}\n\
- along with your other target hooks.",
+ "This hook is used to determine the level of target support for\n\
+``__builtin_speculation_safe_value``. If called with an argument\n\
+of false, it returns true if the target has been modified to support\n\
+this builtin. If called with an argument of true, it returns true\n\
+if the target requires active mitigation execution might be speculative.\n\
+\n\
+The default implementation returns false if the target does not define\n\
+a pattern named ``speculation_barrier``. Else it returns true\n\
+for the first case and whether the pattern is enabled for the current\n\
+compilation for the second case.\n\
+\n\
+For targets that have no processors that can execute instructions\n\
+speculatively an alternative implemenation of this hook is available:\n\
+simply redefine this hook to ``speculation_safe_value_not_needed``\n\
+along with your other target hooks.",
bool, (bool active), default_have_speculation_safe_value)
DEFHOOK
(speculation_safe_value,
-"This target hook can be used to generate a target-specific code\n\
- sequence that implements the @code{__builtin_speculation_safe_value}\n\
- built-in function. The function must always return @var{val} in\n\
- @var{result} in mode @var{mode} when the cpu is not executing\n\
- speculatively, but must never return that when speculating until it\n\
- is known that the speculation will not be unwound. The hook supports\n\
- two primary mechanisms for implementing the requirements. The first\n\
- is to emit a speculation barrier which forces the processor to wait\n\
- until all prior speculative operations have been resolved; the second\n\
- is to use a target-specific mechanism that can track the speculation\n\
- state and to return @var{failval} if it can determine that\n\
- speculation must be unwound at a later time.\n\
- \n\
- The default implementation simply copies @var{val} to @var{result} and\n\
- emits a @code{speculation_barrier} instruction if that is defined.",
+ "This target hook can be used to generate a target-specific code\n\
+sequence that implements the ``__builtin_speculation_safe_value``\n\
+built-in function. The function must always return :samp:`{val}` in\n\
+:samp:`{result}` in mode :samp:`{mode}` when the cpu is not executing\n\
+speculatively, but must never return that when speculating until it\n\
+is known that the speculation will not be unwound. The hook supports\n\
+two primary mechanisms for implementing the requirements. The first\n\
+is to emit a speculation barrier which forces the processor to wait\n\
+until all prior speculative operations have been resolved; the second\n\
+is to use a target-specific mechanism that can track the speculation\n\
+state and to return :samp:`{failval}` if it can determine that\n\
+speculation must be unwound at a later time.\n\
+\n\
+The default implementation simply copies :samp:`{val}` to :samp:`{result}` and\n\
+emits a ``speculation_barrier`` instruction if that is defined.",
rtx, (machine_mode mode, rtx result, rtx val, rtx failval),
default_speculation_safe_value)
DEFHOOK
(predict_doloop_p,
"Return true if we can predict it is possible to use a low-overhead loop\n\
-for a particular loop. The parameter @var{loop} is a pointer to the loop.\n\
+for a particular loop. The parameter :samp:`{loop}` is a pointer to the loop.\n\
This target hook is required only when the target supports low-overhead\n\
loops, and will help ivopts to make some decisions.\n\
The default version of this hook returns false.",
@@ -4427,16 +4424,16 @@ The default value is zero.",
DEFHOOK
(can_use_doloop_p,
- "Return true if it is possible to use low-overhead loops (@code{doloop_end}\n\
-and @code{doloop_begin}) for a particular loop. @var{iterations} gives the\n\
-exact number of iterations, or 0 if not known. @var{iterations_max} gives\n\
-the maximum number of iterations, or 0 if not known. @var{loop_depth} is\n\
+ "Return true if it is possible to use low-overhead loops (``doloop_end``\n\
+and ``doloop_begin``) for a particular loop. :samp:`{iterations}` gives the\n\
+exact number of iterations, or 0 if not known. :samp:`{iterations_max}` gives\n\
+the maximum number of iterations, or 0 if not known. :samp:`{loop_depth}` is\n\
the nesting depth of the loop, with 1 for innermost loops, 2 for loops that\n\
-contain innermost loops, and so on. @var{entered_at_top} is true if the\n\
+contain innermost loops, and so on. :samp:`{entered_at_top}` is true if the\n\
loop is only entered from the top.\n\
\n\
-This hook is only used if @code{doloop_end} is available. The default\n\
-implementation returns true. You can use @code{can_use_doloop_if_innermost}\n\
+This hook is only used if ``doloop_end`` is available. The default\n\
+implementation returns true. You can use ``can_use_doloop_if_innermost``\n\
if the loop must be the innermost, and if there are no other restrictions.",
bool, (const widest_int &iterations, const widest_int &iterations_max,
unsigned int loop_depth, bool entered_at_top),
@@ -4446,8 +4443,7 @@ if the loop must be the innermost, and if there are no other restrictions.",
otherwise it returns an error message. */
DEFHOOK
(invalid_within_doloop,
- "\n\
-Take an instruction in @var{insn} and return NULL if it is valid within a\n\
+ "Take an instruction in :samp:`{insn}` and return NULL if it is valid within a\n\
low-overhead loop, otherwise return a string explaining why doloop\n\
could not be applied.\n\
\n\
@@ -4462,12 +4458,12 @@ loops containing function calls or branch on table instructions.",
/* Returns the machine mode which the target prefers for doloop IV. */
DEFHOOK
(preferred_doloop_mode,
-"This hook takes a @var{mode} for a doloop IV, where @code{mode} is the\n\
+ "This hook takes a :samp:`{mode}` for a doloop IV, where ``mode`` is the\n\
original mode for the operation. If the target prefers an alternate\n\
-@code{mode} for the operation, then this hook should return that mode;\n\
-otherwise the original @code{mode} should be returned. For example, on a\n\
-64-bit target, @code{DImode} might be preferred over @code{SImode}. Both the\n\
-original and the returned modes should be @code{MODE_INT}.",
+``mode`` for the operation, then this hook should return that mode;\n\
+otherwise the original ``mode`` should be returned. For example, on a\n\
+64-bit target, ``DImode`` might be preferred over ``SImode``. Both the\n\
+original and the returned modes should be ``MODE_INT``.",
machine_mode,
(machine_mode mode),
default_preferred_doloop_mode)
@@ -4475,7 +4471,7 @@ original and the returned modes should be @code{MODE_INT}.",
/* Returns true for a legitimate combined insn. */
DEFHOOK
(legitimate_combined_insn,
-"Take an instruction in @var{insn} and return @code{false} if the instruction\n\
+ "Take an instruction in :samp:`{insn}` and return ``false`` if the instruction\n\
is not appropriate as a combination of two or more instructions. The\n\
default is to accept all instructions.",
bool, (rtx_insn *insn),
@@ -4483,9 +4479,9 @@ default is to accept all instructions.",
DEFHOOK
(valid_dllimport_attribute_p,
-"@var{decl} is a variable or function with @code{__attribute__((dllimport))}\n\
+ ":samp:`{decl}` is a variable or function with ``__attribute__((dllimport))``\n\
specified. Use this hook if the target needs to add extra validation\n\
-checks to @code{handle_dll_attribute}.",
+checks to ``handle_dll_attribute``.",
bool, (const_tree decl),
hook_bool_const_tree_true)
@@ -4501,12 +4497,12 @@ subtraction. We accomplish this through CSE. Besides the value of\n\
the constant we also add a lower and an upper constant anchor to the\n\
available expressions. These are then queried when encountering new\n\
constants. The anchors are computed by rounding the constant up and\n\
-down to a multiple of the value of @code{TARGET_CONST_ANCHOR}.\n\
-@code{TARGET_CONST_ANCHOR} should be the maximum positive value\n\
+down to a multiple of the value of ``TARGET_CONST_ANCHOR``.\n\
+``TARGET_CONST_ANCHOR`` should be the maximum positive value\n\
accepted by immediate-add plus one. We currently assume that the\n\
-value of @code{TARGET_CONST_ANCHOR} is a power of 2. For example, on\n\
+value of ``TARGET_CONST_ANCHOR`` is a power of 2. For example, on\n\
MIPS, where add-immediate takes a 16-bit signed value,\n\
-@code{TARGET_CONST_ANCHOR} is set to @samp{0x8000}. The default value\n\
+``TARGET_CONST_ANCHOR`` is set to :samp:`0x8000`. The default value\n\
is zero, which disables this optimization.",
unsigned HOST_WIDE_INT, 0)
@@ -4535,34 +4531,34 @@ HOOK_VECTOR (TARGET_CALLS, calls)
DEFHOOK
(promote_function_mode,
- "Like @code{PROMOTE_MODE}, but it is applied to outgoing function arguments or\n\
+ "Like ``PROMOTE_MODE``, but it is applied to outgoing function arguments or\n\
function return values. The target hook should return the new mode\n\
-and possibly change @code{*@var{punsignedp}} if the promotion should\n\
-change signedness. This function is called only for scalar @emph{or\n\
-pointer} types.\n\
-\n\
-@var{for_return} allows to distinguish the promotion of arguments and\n\
-return values. If it is @code{1}, a return value is being promoted and\n\
-@code{TARGET_FUNCTION_VALUE} must perform the same promotions done here.\n\
-If it is @code{2}, the returned mode should be that of the register in\n\
+and possibly change ``*punsignedp`` if the promotion should\n\
+change signedness. This function is called only for scalar *or\n\
+pointer* types.\n\
+\n\
+:samp:`{for_return}` allows to distinguish the promotion of arguments and\n\
+return values. If it is ``1``, a return value is being promoted and\n\
+``TARGET_FUNCTION_VALUE`` must perform the same promotions done here.\n\
+If it is ``2``, the returned mode should be that of the register in\n\
which an incoming parameter is copied, or the outgoing result is computed;\n\
-then the hook should return the same mode as @code{promote_mode}, though\n\
+then the hook should return the same mode as ``promote_mode``, though\n\
the signedness may be different.\n\
\n\
-@var{type} can be NULL when promoting function arguments of libcalls.\n\
+:samp:`{type}` can be NULL when promoting function arguments of libcalls.\n\
\n\
The default is to not promote arguments and return values. You can\n\
-also define the hook to @code{default_promote_function_mode_always_promote}\n\
-if you would like to apply the same rules given by @code{PROMOTE_MODE}.",
+also define the hook to ``default_promote_function_mode_always_promote``\n\
+if you would like to apply the same rules given by ``PROMOTE_MODE``.",
machine_mode, (const_tree type, machine_mode mode, int *punsignedp,
const_tree funtype, int for_return),
default_promote_function_mode)
DEFHOOK
(promote_prototypes,
- "This target hook returns @code{true} if an argument declared in a\n\
-prototype as an integral type smaller than @code{int} should actually be\n\
-passed as an @code{int}. In addition to avoiding errors in certain\n\
+ "This target hook returns ``true`` if an argument declared in a\n\
+prototype as an integral type smaller than ``int`` should actually be\n\
+passed as an ``int``. In addition to avoiding errors in certain\n\
cases of mismatch, it also makes for better code on certain machines.\n\
The default is to not promote prototypes.",
bool, (const_tree fntype),
@@ -4571,23 +4567,23 @@ The default is to not promote prototypes.",
DEFHOOK
(struct_value_rtx,
"This target hook should return the location of the structure value\n\
-address (normally a @code{mem} or @code{reg}), or 0 if the address is\n\
-passed as an ``invisible'' first argument. Note that @var{fndecl} may\n\
-be @code{NULL}, for libcalls. You do not need to define this target\n\
-hook if the address is always passed as an ``invisible'' first\n\
+address (normally a ``mem`` or ``reg``), or 0 if the address is\n\
+passed as an 'invisible' first argument. Note that :samp:`{fndecl}` may\n\
+be ``NULL``, for libcalls. You do not need to define this target\n\
+hook if the address is always passed as an 'invisible' first\n\
argument.\n\
\n\
On some architectures the place where the structure value address\n\
is found by the called function is not the same place that the\n\
caller put it. This can be due to register windows, or it could\n\
be because the function prologue moves it to a different place.\n\
-@var{incoming} is @code{1} or @code{2} when the location is needed in\n\
-the context of the called function, and @code{0} in the context of\n\
+:samp:`{incoming}` is ``1`` or ``2`` when the location is needed in\n\
+the context of the called function, and ``0`` in the context of\n\
the caller.\n\
\n\
-If @var{incoming} is nonzero and the address is to be found on the\n\
-stack, return a @code{mem} which refers to the frame pointer. If\n\
-@var{incoming} is @code{2}, the result is being used to fetch the\n\
+If :samp:`{incoming}` is nonzero and the address is to be found on the\n\
+stack, return a ``mem`` which refers to the frame pointer. If\n\
+:samp:`{incoming}` is ``2``, the result is being used to fetch the\n\
structure value address at the beginning of a function. If you need\n\
to emit adjusting code, you should do it at this point.",
rtx, (tree fndecl, int incoming),
@@ -4606,35 +4602,35 @@ DEFHOOK
(return_in_memory,
"This target hook should return a nonzero value to say to return the\n\
function value in memory, just as large structures are always returned.\n\
-Here @var{type} will be the data type of the value, and @var{fntype}\n\
-will be the type of the function doing the returning, or @code{NULL} for\n\
+Here :samp:`{type}` will be the data type of the value, and :samp:`{fntype}`\n\
+will be the type of the function doing the returning, or ``NULL`` for\n\
libcalls.\n\
\n\
-Note that values of mode @code{BLKmode} must be explicitly handled\n\
-by this function. Also, the option @option{-fpcc-struct-return}\n\
+Note that values of mode ``BLKmode`` must be explicitly handled\n\
+by this function. Also, the option :option:`-fpcc-struct-return`\n\
takes effect regardless of this macro. On most systems, it is\n\
possible to leave the hook undefined; this causes a default\n\
-definition to be used, whose value is the constant 1 for @code{BLKmode}\n\
+definition to be used, whose value is the constant 1 for ``BLKmode``\n\
values, and 0 otherwise.\n\
\n\
Do not use this hook to indicate that structures and unions should always\n\
-be returned in memory. You should instead use @code{DEFAULT_PCC_STRUCT_RETURN}\n\
+be returned in memory. You should instead use ``DEFAULT_PCC_STRUCT_RETURN``\n\
to indicate this.",
bool, (const_tree type, const_tree fntype),
default_return_in_memory)
DEFHOOK
(return_in_msb,
- "This hook should return true if values of type @var{type} are returned\n\
+ "This hook should return true if values of type :samp:`{type}` are returned\n\
at the most significant end of a register (in other words, if they are\n\
-padded at the least significant end). You can assume that @var{type}\n\
+padded at the least significant end). You can assume that :samp:`{type}`\n\
is returned in a register; the caller is required to check this.\n\
\n\
-Note that the register provided by @code{TARGET_FUNCTION_VALUE} must\n\
+Note that the register provided by ``TARGET_FUNCTION_VALUE`` must\n\
be able to hold the complete return value. For example, if a 1-, 2-\n\
or 3-byte structure is returned at the most significant end of a\n\
-4-byte register, @code{TARGET_FUNCTION_VALUE} should provide an\n\
-@code{SImode} rtx.",
+4-byte register, ``TARGET_FUNCTION_VALUE`` should provide an\n\
+``SImode`` rtx.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -4643,10 +4639,10 @@ or 3-byte structure is returned at the most significant end of a\n\
from __builtin_va_arg. */
DEFHOOK
(pass_by_reference,
- "This target hook should return @code{true} if argument @var{arg} at the\n\
-position indicated by @var{cum} should be passed by reference. This\n\
+ "This target hook should return ``true`` if argument :samp:`{arg}` at the\n\
+position indicated by :samp:`{cum}` should be passed by reference. This\n\
predicate is queried after target independent reasons for being\n\
-passed by reference, such as @code{TREE_ADDRESSABLE (@var{arg}.type)}.\n\
+passed by reference, such as ``TREE_ADDRESSABLE (arg.type)``.\n\
\n\
If the hook returns true, a copy of that argument is made in memory and a\n\
pointer to the argument is passed instead of the argument itself.\n\
@@ -4659,10 +4655,10 @@ to that type.",
DEFHOOK
(expand_builtin_saveregs,
"If defined, this hook produces the machine-specific code for a call to\n\
-@code{__builtin_saveregs}. This code will be moved to the very\n\
+``__builtin_saveregs``. This code will be moved to the very\n\
beginning of the function, before any parameter access are made. The\n\
return value of this function should be an RTX that contains the value\n\
-to use as the return of @code{__builtin_saveregs}.",
+to use as the return of ``__builtin_saveregs``.",
rtx, (void),
default_expand_builtin_saveregs)
@@ -4670,37 +4666,37 @@ to use as the return of @code{__builtin_saveregs}.",
DEFHOOK
(setup_incoming_varargs,
"This target hook offers an alternative to using\n\
-@code{__builtin_saveregs} and defining the hook\n\
-@code{TARGET_EXPAND_BUILTIN_SAVEREGS}. Use it to store the anonymous\n\
+``__builtin_saveregs`` and defining the hook\n\
+``TARGET_EXPAND_BUILTIN_SAVEREGS``. Use it to store the anonymous\n\
register arguments into the stack so that all the arguments appear to\n\
have been passed consecutively on the stack. Once this is done, you can\n\
use the standard implementation of varargs that works for machines that\n\
pass all their arguments on the stack.\n\
\n\
-The argument @var{args_so_far} points to the @code{CUMULATIVE_ARGS} data\n\
+The argument :samp:`{args_so_far}` points to the ``CUMULATIVE_ARGS`` data\n\
structure, containing the values that are obtained after processing the\n\
-named arguments. The argument @var{arg} describes the last of these named\n\
-arguments. The argument @var{arg} should not be used if the function type\n\
-satisfies @code{TYPE_NO_NAMED_ARGS_STDARG_P}, since in that case there are\n\
-no named arguments and all arguments are accessed with @code{va_arg}.\n\
+named arguments. The argument :samp:`{arg}` describes the last of these named\n\
+arguments. The argument :samp:`{arg}` should not be used if the function type\n\
+satisfies ``TYPE_NO_NAMED_ARGS_STDARG_P``, since in that case there are\n\
+no named arguments and all arguments are accessed with ``va_arg``.\n\
\n\
The target hook should do two things: first, push onto the stack all the\n\
-argument registers @emph{not} used for the named arguments, and second,\n\
-store the size of the data thus pushed into the @code{int}-valued\n\
-variable pointed to by @var{pretend_args_size}. The value that you\n\
+argument registers *not* used for the named arguments, and second,\n\
+store the size of the data thus pushed into the ``int`` -valued\n\
+variable pointed to by :samp:`{pretend_args_size}`. The value that you\n\
store here will serve as additional offset for setting up the stack\n\
frame.\n\
\n\
Because you must generate code to push the anonymous arguments at\n\
compile time without knowing their data types,\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is only useful on machines that\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is only useful on machines that\n\
have just a single category of argument register and use it uniformly\n\
for all data types.\n\
\n\
-If the argument @var{second_time} is nonzero, it means that the\n\
+If the argument :samp:`{second_time}` is nonzero, it means that the\n\
arguments of the function are being analyzed for the second time. This\n\
happens for an inline function, which is not actually compiled until the\n\
-end of the source file. The hook @code{TARGET_SETUP_INCOMING_VARARGS} should\n\
+end of the source file. The hook ``TARGET_SETUP_INCOMING_VARARGS`` should\n\
not generate any instructions in this case.",
void, (cumulative_args_t args_so_far, const function_arg_info &arg,
int *pretend_args_size, int second_time),
@@ -4710,14 +4706,14 @@ DEFHOOK
(call_args,
"While generating RTL for a function call, this target hook is invoked once\n\
for each argument passed to the function, either a register returned by\n\
-@code{TARGET_FUNCTION_ARG} or a memory location. It is called just\n\
+``TARGET_FUNCTION_ARG`` or a memory location. It is called just\n\
before the point where argument registers are stored. The type of the\n\
function to be called is also passed as the second argument; it is\n\
-@code{NULL_TREE} for libcalls. The @code{TARGET_END_CALL_ARGS} hook is\n\
+``NULL_TREE`` for libcalls. The ``TARGET_END_CALL_ARGS`` hook is\n\
invoked just after the code to copy the return reg has been emitted.\n\
This functionality can be used to perform special setup of call argument\n\
registers if a target needs it.\n\
-For functions without arguments, the hook is called once with @code{pc_rtx}\n\
+For functions without arguments, the hook is called once with ``pc_rtx``\n\
passed instead of an argument register.\n\
Most ports do not need to implement anything for this hook.",
void, (rtx, tree),
@@ -4735,32 +4731,32 @@ Most ports do not need to implement anything for this hook.",
DEFHOOK
(push_argument,
- "This target hook returns @code{true} if push instructions will be\n\
+ "This target hook returns ``true`` if push instructions will be\n\
used to pass outgoing arguments. When the push instruction usage is\n\
-optional, @var{npush} is nonzero to indicate the number of bytes to\n\
-push. Otherwise, @var{npush} is zero. If the target machine does not\n\
+optional, :samp:`{npush}` is nonzero to indicate the number of bytes to\n\
+push. Otherwise, :samp:`{npush}` is zero. If the target machine does not\n\
have a push instruction or push instruction should be avoided,\n\
-@code{false} should be returned. That directs GCC to use an alternate\n\
+``false`` should be returned. That directs GCC to use an alternate\n\
strategy: to allocate the entire argument block and then store the\n\
-arguments into it. If this target hook may return @code{true},\n\
-@code{PUSH_ROUNDING} must be defined.",
+arguments into it. If this target hook may return ``true``,\n\
+``PUSH_ROUNDING`` must be defined.",
bool, (unsigned int npush),
default_push_argument)
DEFHOOK
(strict_argument_naming,
- "Define this hook to return @code{true} if the location where a function\n\
+ "Define this hook to return ``true`` if the location where a function\n\
argument is passed depends on whether or not it is a named argument.\n\
\n\
-This hook controls how the @var{named} argument to @code{TARGET_FUNCTION_ARG}\n\
+This hook controls how the :samp:`{named}` argument to ``TARGET_FUNCTION_ARG``\n\
is set for varargs and stdarg functions. If this hook returns\n\
-@code{true}, the @var{named} argument is always true for named\n\
-arguments, and false for unnamed arguments. If it returns @code{false},\n\
-but @code{TARGET_PRETEND_OUTGOING_VARARGS_NAMED} returns @code{true},\n\
+``true``, the :samp:`{named}` argument is always true for named\n\
+arguments, and false for unnamed arguments. If it returns ``false``,\n\
+but ``TARGET_PRETEND_OUTGOING_VARARGS_NAMED`` returns ``true``,\n\
then all arguments are treated as named. Otherwise, all named arguments\n\
except the last are treated as named.\n\
\n\
-You need not define this hook if it always returns @code{false}.",
+You need not define this hook if it always returns ``false``.",
bool, (cumulative_args_t ca),
hook_bool_CUMULATIVE_ARGS_false)
@@ -4770,10 +4766,10 @@ You need not define this hook if it always returns @code{false}.",
DEFHOOK
(pretend_outgoing_varargs_named,
"If you need to conditionally change ABIs so that one works with\n\
-@code{TARGET_SETUP_INCOMING_VARARGS}, but the other works like neither\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} nor @code{TARGET_STRICT_ARGUMENT_NAMING} was\n\
-defined, then define this hook to return @code{true} if\n\
-@code{TARGET_SETUP_INCOMING_VARARGS} is used, @code{false} otherwise.\n\
+``TARGET_SETUP_INCOMING_VARARGS``, but the other works like neither\n\
+``TARGET_SETUP_INCOMING_VARARGS`` nor ``TARGET_STRICT_ARGUMENT_NAMING`` was\n\
+defined, then define this hook to return ``true`` if\n\
+``TARGET_SETUP_INCOMING_VARARGS`` is used, ``false`` otherwise.\n\
Otherwise, you should not define this hook.",
bool, (cumulative_args_t ca),
default_pretend_outgoing_varargs_named)
@@ -4782,7 +4778,7 @@ Otherwise, you should not define this hook.",
should be passed as two scalars. */
DEFHOOK
(split_complex_arg,
- "This hook should return true if parameter of type @var{type} are passed\n\
+ "This hook should return true if parameter of type :samp:`{type}` are passed\n\
as two scalar parameters. By default, GCC will attempt to pack complex\n\
arguments into the target's word size. Some ABIs require complex arguments\n\
to be split and treated as their individual components. For example, on\n\
@@ -4790,7 +4786,7 @@ AIX64, complex floats should be passed in a pair of floating point\n\
registers, even though a complex float would fit in one 64-bit floating\n\
point register.\n\
\n\
-The default value of this hook is @code{NULL}, which is treated as always\n\
+The default value of this hook is ``NULL``, which is treated as always\n\
false.",
bool, (const_tree type), NULL)
@@ -4800,9 +4796,9 @@ false.",
Need audit to verify that this is the case. */
DEFHOOK
(must_pass_in_stack,
- "This target hook should return @code{true} if we should not pass @var{arg}\n\
-solely in registers. The file @file{expr.h} defines a\n\
-definition that is usually appropriate, refer to @file{expr.h} for additional\n\
+ "This target hook should return ``true`` if we should not pass :samp:`{arg}`\n\
+solely in registers. The file :samp:`expr.h` defines a\n\
+definition that is usually appropriate, refer to :samp:`expr.h` for additional\n\
documentation.",
bool, (const function_arg_info &arg),
must_pass_in_stack_var_size_or_pad)
@@ -4839,14 +4835,14 @@ pushed on the stack.\n\
On some machines, certain arguments must be passed partially in\n\
registers and partially in memory. On these machines, typically the\n\
first few words of arguments are passed in registers, and the rest\n\
-on the stack. If a multi-word argument (a @code{double} or a\n\
+on the stack. If a multi-word argument (a ``double`` or a\n\
structure) crosses that boundary, its first few words must be passed\n\
in registers and the rest must be pushed. This macro tells the\n\
compiler when this occurs, and how many bytes should go in registers.\n\
\n\
-@code{TARGET_FUNCTION_ARG} for these arguments should return the first\n\
+``TARGET_FUNCTION_ARG`` for these arguments should return the first\n\
register to be used by the caller for this argument; likewise\n\
-@code{TARGET_FUNCTION_INCOMING_ARG}, for the called function.",
+``TARGET_FUNCTION_INCOMING_ARG``, for the called function.",
int, (cumulative_args_t cum, const function_arg_info &arg),
hook_int_CUMULATIVE_ARGS_arg_info_0)
@@ -4855,10 +4851,10 @@ register to be used by the caller for this argument; likewise\n\
argument. */
DEFHOOK
(function_arg_advance,
- "This hook updates the summarizer variable pointed to by @var{ca} to\n\
-advance past argument @var{arg} in the argument list. Once this is done,\n\
-the variable @var{cum} is suitable for analyzing the @emph{following}\n\
-argument with @code{TARGET_FUNCTION_ARG}, etc.\n\
+ "This hook updates the summarizer variable pointed to by :samp:`{ca}` to\n\
+advance past argument :samp:`{arg}` in the argument list. Once this is done,\n\
+the variable :samp:`{cum}` is suitable for analyzing the *following*\n\
+argument with ``TARGET_FUNCTION_ARG``, etc.\n\
\n\
This hook need not do anything if the argument in question was passed\n\
on the stack. The compiler knows how to track the amount of stack space\n\
@@ -4870,8 +4866,8 @@ used for arguments without any special help.",
DEFHOOK
(function_arg_offset,
"This hook returns the number of bytes to add to the offset of an\n\
-argument of type @var{type} and mode @var{mode} when passed in memory.\n\
-This is needed for the SPU, which passes @code{char} and @code{short}\n\
+argument of type :samp:`{type}` and mode :samp:`{mode}` when passed in memory.\n\
+This is needed for the SPU, which passes ``char`` and ``short``\n\
arguments in the preferred slot that is in the middle of the quad word\n\
instead of starting at the top. The default implementation returns 0.",
HOST_WIDE_INT, (machine_mode mode, const_tree type),
@@ -4880,18 +4876,18 @@ instead of starting at the top. The default implementation returns 0.",
DEFHOOK
(function_arg_padding,
"This hook determines whether, and in which direction, to pad out\n\
-an argument of mode @var{mode} and type @var{type}. It returns\n\
-@code{PAD_UPWARD} to insert padding above the argument, @code{PAD_DOWNWARD}\n\
-to insert padding below the argument, or @code{PAD_NONE} to inhibit padding.\n\
+an argument of mode :samp:`{mode}` and type :samp:`{type}`. It returns\n\
+``PAD_UPWARD`` to insert padding above the argument, ``PAD_DOWNWARD``\n\
+to insert padding below the argument, or ``PAD_NONE`` to inhibit padding.\n\
\n\
-The @emph{amount} of padding is not controlled by this hook, but by\n\
-@code{TARGET_FUNCTION_ARG_ROUND_BOUNDARY}. It is always just enough\n\
+The *amount* of padding is not controlled by this hook, but by\n\
+``TARGET_FUNCTION_ARG_ROUND_BOUNDARY``. It is always just enough\n\
to reach the next multiple of that boundary.\n\
\n\
This hook has a default definition that is right for most systems.\n\
For little-endian machines, the default is to pad upward. For\n\
big-endian machines, the default is to pad downward for an argument of\n\
-constant size shorter than an @code{int}, and upward otherwise.",
+constant size shorter than an ``int``, and upward otherwise.",
pad_direction, (machine_mode mode, const_tree type),
default_function_arg_padding)
@@ -4901,46 +4897,47 @@ constant size shorter than an @code{int}, and upward otherwise.",
argument. */
DEFHOOK
(function_arg,
- "Return an RTX indicating whether function argument @var{arg} is passed\n\
-in a register and if so, which register. Argument @var{ca} summarizes all\n\
+ "Return an RTX indicating whether function argument :samp:`{arg}` is passed\n\
+in a register and if so, which register. Argument :samp:`{ca}` summarizes all\n\
the previous arguments.\n\
\n\
-The return value is usually either a @code{reg} RTX for the hard\n\
+The return value is usually either a ``reg`` RTX for the hard\n\
register in which to pass the argument, or zero to pass the argument\n\
on the stack.\n\
\n\
-The value of the expression can also be a @code{parallel} RTX@. This is\n\
+The value of the expression can also be a ``parallel`` RTX. This is\n\
used when an argument is passed in multiple locations. The mode of the\n\
-@code{parallel} should be the mode of the entire argument. The\n\
-@code{parallel} holds any number of @code{expr_list} pairs; each one\n\
+``parallel`` should be the mode of the entire argument. The\n\
+``parallel`` holds any number of ``expr_list`` pairs; each one\n\
describes where part of the argument is passed. In each\n\
-@code{expr_list} the first operand must be a @code{reg} RTX for the hard\n\
+``expr_list`` the first operand must be a ``reg`` RTX for the hard\n\
register in which to pass this part of the argument, and the mode of the\n\
register RTX indicates how large this part of the argument is. The\n\
-second operand of the @code{expr_list} is a @code{const_int} which gives\n\
+second operand of the ``expr_list`` is a ``const_int`` which gives\n\
the offset in bytes into the entire argument of where this part starts.\n\
-As a special exception the first @code{expr_list} in the @code{parallel}\n\
+As a special exception the first ``expr_list`` in the ``parallel``\n\
RTX may have a first operand of zero. This indicates that the entire\n\
argument is also stored on the stack.\n\
\n\
-The last time this hook is called, it is called with @code{MODE ==\n\
-VOIDmode}, and its result is passed to the @code{call} or @code{call_value}\n\
+The last time this hook is called, it is called with ``MODE ==\n\
+VOIDmode``, and its result is passed to the ``call`` or ``call_value``\n\
pattern as operands 2 and 3 respectively.\n\
\n\
-@cindex @file{stdarg.h} and register arguments\n\
-The usual way to make the ISO library @file{stdarg.h} work on a\n\
+.. index:: stdarg.h and register arguments\n\
+\n\
+The usual way to make the ISO library :samp:`stdarg.h` work on a\n\
machine where some arguments are usually passed in registers, is to\n\
cause nameless arguments to be passed on the stack instead. This is\n\
-done by making @code{TARGET_FUNCTION_ARG} return 0 whenever\n\
-@var{named} is @code{false}.\n\
+done by making ``TARGET_FUNCTION_ARG`` return 0 whenever\n\
+:samp:`{named}` is ``false``.\n\
+\n\
+.. index:: TARGET_MUST_PASS_IN_STACK, and TARGET_FUNCTION_ARG, REG_PARM_STACK_SPACE, and TARGET_FUNCTION_ARG\n\
\n\
-@cindex @code{TARGET_MUST_PASS_IN_STACK}, and @code{TARGET_FUNCTION_ARG}\n\
-@cindex @code{REG_PARM_STACK_SPACE}, and @code{TARGET_FUNCTION_ARG}\n\
-You may use the hook @code{targetm.calls.must_pass_in_stack}\n\
+You may use the hook ``targetm.calls.must_pass_in_stack``\n\
in the definition of this macro to determine if this argument is of a\n\
-type that must be passed in the stack. If @code{REG_PARM_STACK_SPACE}\n\
-is not defined and @code{TARGET_FUNCTION_ARG} returns nonzero for such an\n\
-argument, the compiler will abort. If @code{REG_PARM_STACK_SPACE} is\n\
+type that must be passed in the stack. If ``REG_PARM_STACK_SPACE``\n\
+is not defined and ``TARGET_FUNCTION_ARG`` returns nonzero for such an\n\
+argument, the compiler will abort. If ``REG_PARM_STACK_SPACE`` is\n\
defined, the argument will be computed in the stack and then loaded into\n\
a register.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
@@ -4953,18 +4950,18 @@ views of where arguments are passed. Also define this hook if there are\n\
functions that are never directly called, but are invoked by the hardware\n\
and which have nonstandard calling conventions.\n\
\n\
-In this case @code{TARGET_FUNCTION_ARG} computes the register in\n\
+In this case ``TARGET_FUNCTION_ARG`` computes the register in\n\
which the caller passes the value, and\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} should be defined in a similar\n\
+``TARGET_FUNCTION_INCOMING_ARG`` should be defined in a similar\n\
fashion to tell the function being called where the arguments will\n\
arrive.\n\
\n\
-@code{TARGET_FUNCTION_INCOMING_ARG} can also return arbitrary address\n\
+``TARGET_FUNCTION_INCOMING_ARG`` can also return arbitrary address\n\
computation using hard register, which can be forced into a register,\n\
so that it can be used to pass special arguments.\n\
\n\
-If @code{TARGET_FUNCTION_INCOMING_ARG} is not defined,\n\
-@code{TARGET_FUNCTION_ARG} serves both purposes.",
+If ``TARGET_FUNCTION_INCOMING_ARG`` is not defined,\n\
+``TARGET_FUNCTION_ARG`` serves both purposes.",
rtx, (cumulative_args_t ca, const function_arg_info &arg),
default_function_incoming_arg)
@@ -4972,13 +4969,13 @@ DEFHOOK
(function_arg_boundary,
"This hook returns the alignment boundary, in bits, of an argument\n\
with the specified mode and type. The default hook returns\n\
-@code{PARM_BOUNDARY} for all arguments.",
+``PARM_BOUNDARY`` for all arguments.",
unsigned int, (machine_mode mode, const_tree type),
default_function_arg_boundary)
DEFHOOK
(function_arg_round_boundary,
- "Normally, the size of an argument is rounded up to @code{PARM_BOUNDARY},\n\
+ "Normally, the size of an argument is rounded up to ``PARM_BOUNDARY``,\n\
which is the default value for this hook. You can define this hook to\n\
return a different value if an argument size must be rounded to a larger\n\
value.",
@@ -4990,8 +4987,8 @@ value.",
DEFHOOK
(invalid_arg_for_unprototyped_fn,
"If defined, this macro returns the diagnostic message when it is\n\
-illegal to pass argument @var{val} to function @var{funcdecl}\n\
-with prototype @var{typelist}.",
+illegal to pass argument :samp:`{val}` to function :samp:`{funcdecl}`\n\
+with prototype :samp:`{typelist}`.",
const char *, (const_tree typelist, const_tree funcdecl, const_tree val),
hook_invalid_arg_for_unprototyped_fn)
@@ -4999,47 +4996,46 @@ with prototype @var{typelist}.",
specified by FN_DECL_OR_TYPE with a return type of RET_TYPE. */
DEFHOOK
(function_value,
- "\n\
-Define this to return an RTX representing the place where a function\n\
-returns or receives a value of data type @var{ret_type}, a tree node\n\
-representing a data type. @var{fn_decl_or_type} is a tree node\n\
-representing @code{FUNCTION_DECL} or @code{FUNCTION_TYPE} of a\n\
-function being called. If @var{outgoing} is false, the hook should\n\
+ "Define this to return an RTX representing the place where a function\n\
+returns or receives a value of data type :samp:`{ret_type}`, a tree node\n\
+representing a data type. :samp:`{fn_decl_or_type}` is a tree node\n\
+representing ``FUNCTION_DECL`` or ``FUNCTION_TYPE`` of a\n\
+function being called. If :samp:`{outgoing}` is false, the hook should\n\
compute the register in which the caller will see the return value.\n\
Otherwise, the hook should return an RTX representing the place where\n\
a function returns a value.\n\
\n\
-On many machines, only @code{TYPE_MODE (@var{ret_type})} is relevant.\n\
+On many machines, only ``TYPE_MODE (ret_type)`` is relevant.\n\
(Actually, on most machines, scalar values are returned in the same\n\
place regardless of mode.) The value of the expression is usually a\n\
-@code{reg} RTX for the hard register where the return value is stored.\n\
-The value can also be a @code{parallel} RTX, if the return value is in\n\
-multiple places. See @code{TARGET_FUNCTION_ARG} for an explanation of the\n\
-@code{parallel} form. Note that the callee will populate every\n\
-location specified in the @code{parallel}, but if the first element of\n\
-the @code{parallel} contains the whole return value, callers will use\n\
+``reg`` RTX for the hard register where the return value is stored.\n\
+The value can also be a ``parallel`` RTX, if the return value is in\n\
+multiple places. See ``TARGET_FUNCTION_ARG`` for an explanation of the\n\
+``parallel`` form. Note that the callee will populate every\n\
+location specified in the ``parallel``, but if the first element of\n\
+the ``parallel`` contains the whole return value, callers will use\n\
that element as the canonical location and ignore the others. The m68k\n\
-port uses this type of @code{parallel} to return pointers in both\n\
-@samp{%a0} (the canonical location) and @samp{%d0}.\n\
+port uses this type of ``parallel`` to return pointers in both\n\
+:samp:`%a0` (the canonical location) and :samp:`%d0`.\n\
\n\
-If @code{TARGET_PROMOTE_FUNCTION_RETURN} returns true, you must apply\n\
-the same promotion rules specified in @code{PROMOTE_MODE} if\n\
-@var{valtype} is a scalar type.\n\
+If ``TARGET_PROMOTE_FUNCTION_RETURN`` returns true, you must apply\n\
+the same promotion rules specified in ``PROMOTE_MODE`` if\n\
+:samp:`{valtype}` is a scalar type.\n\
\n\
-If the precise function being called is known, @var{func} is a tree\n\
-node (@code{FUNCTION_DECL}) for it; otherwise, @var{func} is a null\n\
+If the precise function being called is known, :samp:`{func}` is a tree\n\
+node (``FUNCTION_DECL``) for it; otherwise, :samp:`{func}` is a null\n\
pointer. This makes it possible to use a different value-returning\n\
convention for specific functions when all their calls are\n\
known.\n\
\n\
-Some target machines have ``register windows'' so that the register in\n\
+Some target machines have 'register windows' so that the register in\n\
which a function returns its value is not the same as the one in which\n\
the caller sees the value. For such machines, you should return\n\
-different RTX depending on @var{outgoing}.\n\
+different RTX depending on :samp:`{outgoing}`.\n\
\n\
-@code{TARGET_FUNCTION_VALUE} is not used for return values with\n\
+``TARGET_FUNCTION_VALUE`` is not used for return values with\n\
aggregate data types, because these are returned in another way. See\n\
-@code{TARGET_STRUCT_VALUE_RTX} and related macros, below.",
+``TARGET_STRUCT_VALUE_RTX`` and related macros, below.",
rtx, (const_tree ret_type, const_tree fn_decl_or_type, bool outgoing),
default_function_value)
@@ -5050,8 +5046,8 @@ DEFHOOK
"Define this hook if the back-end needs to know the name of the libcall\n\
function in order to determine where the result should be returned.\n\
\n\
-The mode of the result is given by @var{mode} and the name of the called\n\
-library function is given by @var{fun}. The hook should return an RTX\n\
+The mode of the result is given by :samp:`{mode}` and the name of the called\n\
+library function is given by :samp:`{fun}`. The hook should return an RTX\n\
representing the place where the library function result will be returned.\n\
\n\
If this hook is not defined, then LIBCALL_VALUE will be used.",
@@ -5062,11 +5058,11 @@ If this hook is not defined, then LIBCALL_VALUE will be used.",
a function value as seen by the caller. */
DEFHOOK
(function_value_regno_p,
- "A target hook that return @code{true} if @var{regno} is the number of a hard\n\
+ "A target hook that return ``true`` if :samp:`{regno}` is the number of a hard\n\
register in which the values of called function may come back.\n\
\n\
A register whose use for returning values is limited to serving as the\n\
-second of a pair (for a value of type @code{double}, say) need not be\n\
+second of a pair (for a value of type ``double``, say) need not be\n\
recognized by this target hook.\n\
\n\
If the machine has register windows, so that the caller and the called\n\
@@ -5079,8 +5075,8 @@ If this hook is not defined, then FUNCTION_VALUE_REGNO_P will be used.",
DEFHOOK
(fntype_abi,
- "Return the ABI used by a function with type @var{type}; see the\n\
-definition of @code{predefined_function_abi} for details of the ABI\n\
+ "Return the ABI used by a function with type :samp:`{type}` ; see the\n\
+definition of ``predefined_function_abi`` for details of the ABI\n\
descriptor. Targets only need to define this hook if they support\n\
interoperability between several ABIs in the same translation unit.",
const predefined_function_abi &, (const_tree type),
@@ -5089,9 +5085,9 @@ interoperability between several ABIs in the same translation unit.",
DEFHOOK
(insn_callee_abi,
"This hook returns a description of the ABI used by the target of\n\
-call instruction @var{insn}; see the definition of\n\
-@code{predefined_function_abi} for details of the ABI descriptor.\n\
-Only the global function @code{insn_callee_abi} should call this hook\n\
+call instruction :samp:`{insn}` ; see the definition of\n\
+``predefined_function_abi`` for details of the ABI descriptor.\n\
+Only the global function ``insn_callee_abi`` should call this hook\n\
directly.\n\
\n\
Targets only need to define this hook if they support\n\
@@ -5120,26 +5116,26 @@ DEFHOOK
(get_drap_rtx,
"This hook should return an rtx for Dynamic Realign Argument Pointer (DRAP) if a\n\
different argument pointer register is needed to access the function's\n\
-argument list due to stack realignment. Return @code{NULL} if no DRAP\n\
+argument list due to stack realignment. Return ``NULL`` if no DRAP\n\
is needed.",
rtx, (void), NULL)
/* Generate instruction sequence to zero call used registers. */
DEFHOOK
(zero_call_used_regs,
- "This target hook emits instructions to zero the subset of @var{selected_regs}\n\
+ "This target hook emits instructions to zero the subset of :samp:`{selected_regs}`\n\
that could conceivably contain values that are useful to an attacker.\n\
Return the set of registers that were actually cleared.\n\
\n\
For most targets, the returned set of registers is a subset of\n\
-@var{selected_regs}, however, for some of the targets (for example MIPS),\n\
-clearing some registers that are in the @var{selected_regs} requires\n\
-clearing other call used registers that are not in the @var{selected_regs},\n\
+:samp:`{selected_regs}`, however, for some of the targets (for example MIPS),\n\
+clearing some registers that are in the :samp:`{selected_regs}` requires\n\
+clearing other call used registers that are not in the :samp:`{selected_regs}`,\n\
under such situation, the returned set of registers must be a subset of all\n\
call used registers.\n\
\n\
The default implementation uses normal move instructions to zero\n\
-all the registers in @var{selected_regs}. Define this hook if the\n\
+all the registers in :samp:`{selected_regs}`. Define this hook if the\n\
target has more efficient ways of zeroing certain registers,\n\
or if you believe that certain registers would never contain\n\
values that are useful to an attacker.",
@@ -5154,7 +5150,7 @@ DEFHOOK
arguments should be allocated to stack slots. Normally, GCC allocates\n\
stacks slots for arguments when not optimizing in order to make\n\
debugging easier. However, when a function is declared with\n\
-@code{__attribute__((naked))}, there is no stack frame, and the compiler\n\
+``__attribute__((naked))``, there is no stack frame, and the compiler\n\
cannot safely move arguments from the registers in which they are passed\n\
to the stack. Therefore, this hook should return true in general, but\n\
false for naked functions. The default implementation always returns true.",
@@ -5165,24 +5161,24 @@ false for naked functions. The default implementation always returns true.",
is true, then it should be for the callee; otherwise for the caller. */
DEFHOOK
(static_chain,
- "This hook replaces the use of @code{STATIC_CHAIN_REGNUM} et al for\n\
+ "This hook replaces the use of ``STATIC_CHAIN_REGNUM`` et al for\n\
targets that may use different static chain locations for different\n\
nested functions. This may be required if the target has function\n\
attributes that affect the calling conventions of the function and\n\
those calling conventions use different static chain locations.\n\
\n\
-The default version of this hook uses @code{STATIC_CHAIN_REGNUM} et al.\n\
+The default version of this hook uses ``STATIC_CHAIN_REGNUM`` et al.\n\
\n\
If the static chain is passed in memory, this hook should be used to\n\
-provide rtx giving @code{mem} expressions that denote where they are stored.\n\
-Often the @code{mem} expression as seen by the caller will be at an offset\n\
-from the stack pointer and the @code{mem} expression as seen by the callee\n\
+provide rtx giving ``mem`` expressions that denote where they are stored.\n\
+Often the ``mem`` expression as seen by the caller will be at an offset\n\
+from the stack pointer and the ``mem`` expression as seen by the callee\n\
will be at an offset from the frame pointer.\n\
-@findex stack_pointer_rtx\n\
-@findex frame_pointer_rtx\n\
-@findex arg_pointer_rtx\n\
-The variables @code{stack_pointer_rtx}, @code{frame_pointer_rtx}, and\n\
-@code{arg_pointer_rtx} will have been initialized and should be used\n\
+\n\
+.. index:: stack_pointer_rtx, frame_pointer_rtx, arg_pointer_rtx\n\
+\n\
+The variables ``stack_pointer_rtx``, ``frame_pointer_rtx``, and\n\
+``arg_pointer_rtx`` will have been initialized and should be used\n\
to refer to those items.",
rtx, (const_tree fndecl_or_type, bool incoming_p),
default_static_chain)
@@ -5192,17 +5188,17 @@ to refer to those items.",
DEFHOOK
(trampoline_init,
"This hook is called to initialize a trampoline.\n\
-@var{m_tramp} is an RTX for the memory block for the trampoline; @var{fndecl}\n\
-is the @code{FUNCTION_DECL} for the nested function; @var{static_chain} is an\n\
+:samp:`{m_tramp}` is an RTX for the memory block for the trampoline; :samp:`{fndecl}`\n\
+is the ``FUNCTION_DECL`` for the nested function; :samp:`{static_chain}` is an\n\
RTX for the static chain value that should be passed to the function\n\
when it is called.\n\
\n\
-If the target defines @code{TARGET_ASM_TRAMPOLINE_TEMPLATE}, then the\n\
-first thing this hook should do is emit a block move into @var{m_tramp}\n\
-from the memory block returned by @code{assemble_trampoline_template}.\n\
+If the target defines ``TARGET_ASM_TRAMPOLINE_TEMPLATE``, then the\n\
+first thing this hook should do is emit a block move into :samp:`{m_tramp}`\n\
+from the memory block returned by ``assemble_trampoline_template``.\n\
Note that the block move need only cover the constant parts of the\n\
trampoline. If the target isolates the variable parts of the trampoline\n\
-to the end, not all @code{TRAMPOLINE_SIZE} bytes need be copied.\n\
+to the end, not all ``TRAMPOLINE_SIZE`` bytes need be copied.\n\
\n\
If the target requires any other actions, such as flushing caches\n\
(possibly calling function maybe_emit_call_builtin___clear_cache) or\n\
@@ -5214,12 +5210,12 @@ initializing the trampoline proper.",
/* Emit a call to a function to clear the instruction cache. */
DEFHOOK
(emit_call_builtin___clear_cache,
- "On targets that do not define a @code{clear_cache} insn expander,\n\
-but that define the @code{CLEAR_CACHE_INSN} macro,\n\
+ "On targets that do not define a ``clear_cache`` insn expander,\n\
+but that define the ``CLEAR_CACHE_INSN`` macro,\n\
maybe_emit_call_builtin___clear_cache relies on this target hook\n\
to clear an address range in the instruction cache.\n\
\n\
-The default implementation calls the @code{__clear_cache} builtin,\n\
+The default implementation calls the ``__clear_cache`` builtin,\n\
taking the assembler name from the builtin declaration. Overriding\n\
definitions may call alternate functions, with alternate calling\n\
conventions, or emit alternate RTX to perform the job.",
@@ -5231,11 +5227,11 @@ DEFHOOK
(trampoline_adjust_address,
"This hook should perform any machine-specific adjustment in\n\
the address of the trampoline. Its argument contains the address of the\n\
-memory block that was passed to @code{TARGET_TRAMPOLINE_INIT}. In case\n\
+memory block that was passed to ``TARGET_TRAMPOLINE_INIT``. In case\n\
the address to be used for a function call should be different from the\n\
address at which the template was stored, the different address should\n\
-be returned; otherwise @var{addr} should be returned unchanged.\n\
-If this hook is not defined, @var{addr} will be used for function calls.",
+be returned; otherwise :samp:`{addr}` should be returned unchanged.\n\
+If this hook is not defined, :samp:`{addr}` will be used for function calls.",
rtx, (rtx addr), NULL)
DEFHOOKPOD
@@ -5268,36 +5264,36 @@ DEFHOOK
a function pops on returning, or 0 if the function pops no arguments\n\
and the caller must therefore pop them all after the function returns.\n\
\n\
-@var{fundecl} is a C variable whose value is a tree node that describes\n\
+:samp:`{fundecl}` is a C variable whose value is a tree node that describes\n\
the function in question. Normally it is a node of type\n\
-@code{FUNCTION_DECL} that describes the declaration of the function.\n\
-From this you can obtain the @code{DECL_ATTRIBUTES} of the function.\n\
+``FUNCTION_DECL`` that describes the declaration of the function.\n\
+From this you can obtain the ``DECL_ATTRIBUTES`` of the function.\n\
\n\
-@var{funtype} is a C variable whose value is a tree node that\n\
+:samp:`{funtype}` is a C variable whose value is a tree node that\n\
describes the function in question. Normally it is a node of type\n\
-@code{FUNCTION_TYPE} that describes the data type of the function.\n\
+``FUNCTION_TYPE`` that describes the data type of the function.\n\
From this it is possible to obtain the data types of the value and\n\
arguments (if known).\n\
\n\
-When a call to a library function is being considered, @var{fundecl}\n\
+When a call to a library function is being considered, :samp:`{fundecl}`\n\
will contain an identifier node for the library function. Thus, if\n\
you need to distinguish among various library functions, you can do so\n\
-by their names. Note that ``library function'' in this context means\n\
+by their names. Note that 'library function' in this context means\n\
a function used to perform arithmetic, whose name is known specially\n\
in the compiler and was not mentioned in the C code being compiled.\n\
\n\
-@var{size} is the number of bytes of arguments passed on the\n\
+:samp:`{size}` is the number of bytes of arguments passed on the\n\
stack. If a variable number of bytes is passed, it is zero, and\n\
argument popping will always be the responsibility of the calling function.\n\
\n\
On the VAX, all functions always pop their arguments, so the definition\n\
-of this macro is @var{size}. On the 68000, using the standard\n\
+of this macro is :samp:`{size}`. On the 68000, using the standard\n\
calling convention, no functions pop their arguments, so the value of\n\
the macro is always 0 in this case. But an alternative calling\n\
convention is available in which functions that take a fixed number of\n\
-arguments pop them but other functions (such as @code{printf}) pop\n\
+arguments pop them but other functions (such as ``printf``) pop\n\
nothing (the caller pops all). When this convention is in use,\n\
-@var{funtype} is examined to determine whether a function takes a fixed\n\
+:samp:`{funtype}` is examined to determine whether a function takes a fixed\n\
number of arguments.",
poly_int64, (tree fundecl, tree funtype, poly_int64 size),
default_return_pops_args)
@@ -5307,8 +5303,8 @@ number of arguments.",
DEFHOOK
(get_raw_result_mode,
"This target hook returns the mode to be used when accessing raw return\n\
-registers in @code{__builtin_return}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_return``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5317,8 +5313,8 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(get_raw_arg_mode,
"This target hook returns the mode to be used when accessing raw argument\n\
-registers in @code{__builtin_apply_args}. Define this macro if the value\n\
-in @var{reg_raw_mode} is not correct.",
+registers in ``__builtin_apply_args``. Define this macro if the value\n\
+in :samp:`{reg_raw_mode}` is not correct.",
fixed_size_mode, (int regno),
default_get_reg_raw_mode)
@@ -5326,7 +5322,7 @@ in @var{reg_raw_mode} is not correct.",
DEFHOOK
(empty_record_p,
"This target hook returns true if the type is an empty record. The default\n\
-is to return @code{false}.",
+is to return ``false``.",
bool, (const_tree type),
hook_bool_const_tree_false)
@@ -5359,7 +5355,7 @@ This hook is called at the start of register allocation.",
DEFHOOK
(invalid_conversion,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to convert from @var{fromtype} to @var{totype}, or @code{NULL}\n\
+invalid to convert from :samp:`{fromtype}` to :samp:`{totype}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (const_tree fromtype, const_tree totype),
hook_constcharptr_const_tree_const_tree_null)
@@ -5369,8 +5365,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_unary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} (where unary plus is denoted by\n\
-@code{CONVERT_EXPR}) to an operand of type @var{type}, or @code{NULL}\n\
+invalid to apply operation :samp:`{op}` (where unary plus is denoted by\n\
+``CONVERT_EXPR``) to an operand of type :samp:`{type}`, or ``NULL``\n\
if validity should be determined by the front end.",
const char *, (int op, const_tree type),
hook_constcharptr_int_const_tree_null)
@@ -5380,8 +5376,8 @@ if validity should be determined by the front end.",
DEFHOOK
(invalid_binary_op,
"If defined, this macro returns the diagnostic message when it is\n\
-invalid to apply operation @var{op} to operands of types @var{type1}\n\
-and @var{type2}, or @code{NULL} if validity should be determined by\n\
+invalid to apply operation :samp:`{op}` to operands of types :samp:`{type1}`\n\
+and :samp:`{type2}`, or ``NULL`` if validity should be determined by\n\
the front end.",
const char *, (int op, const_tree type1, const_tree type2),
hook_constcharptr_int_const_tree_const_tree_null)
@@ -5392,8 +5388,8 @@ the front end.",
DEFHOOK
(promoted_type,
"If defined, this target hook returns the type to which values of\n\
-@var{type} should be promoted when they appear in expressions,\n\
-analogous to the integer promotions, or @code{NULL_TREE} to use the\n\
+:samp:`{type}` should be promoted when they appear in expressions,\n\
+analogous to the integer promotions, or ``NULL_TREE`` to use the\n\
front end's normal promotion rules. This hook is useful when there are\n\
target-specific types with special promotion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5405,9 +5401,9 @@ This is currently used only by the C and C++ front ends.",
the standard conversion rules. */
DEFHOOK
(convert_to_type,
- "If defined, this hook returns the result of converting @var{expr} to\n\
-@var{type}. It should return the converted expression,\n\
-or @code{NULL_TREE} to apply the front end's normal conversion rules.\n\
+ "If defined, this hook returns the result of converting :samp:`{expr}` to\n\
+:samp:`{type}`. It should return the converted expression,\n\
+or ``NULL_TREE`` to apply the front end's normal conversion rules.\n\
This hook is useful when there are target-specific types with special\n\
conversion rules.\n\
This is currently used only by the C and C++ front ends.",
@@ -5417,13 +5413,13 @@ This is currently used only by the C and C++ front ends.",
DEFHOOK
(verify_type_context,
"If defined, this hook returns false if there is a target-specific reason\n\
-why type @var{type} cannot be used in the source language context described\n\
-by @var{context}. When @var{silent_p} is false, the hook also reports an\n\
-error against @var{loc} for invalid uses of @var{type}.\n\
+why type :samp:`{type}` cannot be used in the source language context described\n\
+by :samp:`{context}`. When :samp:`{silent_p}` is false, the hook also reports an\n\
+error against :samp:`{loc}` for invalid uses of :samp:`{type}`.\n\
\n\
Calls to this hook should be made through the global function\n\
-@code{verify_type_context}, which makes the @var{silent_p} parameter\n\
-default to false and also handles @code{error_mark_node}.\n\
+``verify_type_context``, which makes the :samp:`{silent_p}` parameter\n\
+default to false and also handles ``error_mark_node``.\n\
\n\
The default implementation always returns true.",
bool, (location_t loc, type_context_kind context, const_tree type,
@@ -5433,31 +5429,31 @@ The default implementation always returns true.",
DEFHOOK
(can_change_mode_class,
"This hook returns true if it is possible to bitcast values held in\n\
-registers of class @var{rclass} from mode @var{from} to mode @var{to}\n\
+registers of class :samp:`{rclass}` from mode :samp:`{from}` to mode :samp:`{to}`\n\
and if doing so preserves the low-order bits that are common to both modes.\n\
-The result is only meaningful if @var{rclass} has registers that can hold\n\
-both @code{from} and @code{to}. The default implementation returns true.\n\
+The result is only meaningful if :samp:`{rclass}` has registers that can hold\n\
+both ``from`` and ``to``. The default implementation returns true.\n\
\n\
As an example of when such bitcasting is invalid, loading 32-bit integer or\n\
floating-point objects into floating-point registers on Alpha extends them\n\
to 64 bits. Therefore loading a 64-bit object and then storing it as a\n\
32-bit object does not store the low-order 32 bits, as would be the case\n\
-for a normal register. Therefore, @file{alpha.h} defines\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} to return:\n\
+for a normal register. Therefore, :samp:`alpha.h` defines\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` to return:\n\
+\n\
+.. code-block:: c++\n\
\n\
-@smallexample\n\
-(GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
- || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
-@end smallexample\n\
+ (GET_MODE_SIZE (from) == GET_MODE_SIZE (to)\n\
+ || !reg_classes_intersect_p (FLOAT_REGS, rclass))\n\
\n\
-Even if storing from a register in mode @var{to} would be valid,\n\
-if both @var{from} and @code{raw_reg_mode} for @var{rclass} are wider\n\
-than @code{word_mode}, then we must prevent @var{to} narrowing the\n\
+Even if storing from a register in mode :samp:`{to}` would be valid,\n\
+if both :samp:`{from}` and ``raw_reg_mode`` for :samp:`{rclass}` are wider\n\
+than ``word_mode``, then we must prevent :samp:`{to}` narrowing the\n\
mode. This happens when the middle-end assumes that it can load\n\
-or store pieces of an @var{N}-word pseudo, and that the pseudo will\n\
-eventually be allocated to @var{N} @code{word_mode} hard registers.\n\
+or store pieces of an :samp:`{N}` -word pseudo, and that the pseudo will\n\
+eventually be allocated to :samp:`{N}` ``word_mode`` hard registers.\n\
Failure to prevent this kind of mode change will result in the\n\
-entire @code{raw_reg_mode} being modified instead of the partial\n\
+entire ``raw_reg_mode`` being modified instead of the partial\n\
value that the middle-end intended.",
bool, (machine_mode from, machine_mode to, reg_class_t rclass),
hook_bool_mode_mode_reg_class_t_true)
@@ -5466,9 +5462,9 @@ value that the middle-end intended.",
DEFHOOK
(ira_change_pseudo_allocno_class,
"A target hook which can change allocno class for given pseudo from\n\
- allocno and best class calculated by IRA.\n\
- \n\
- The default version of this target hook always returns given class.",
+allocno and best class calculated by IRA.\n\
+\n\
+The default version of this target hook always returns given class.",
reg_class_t, (int, reg_class_t, reg_class_t),
default_ira_change_pseudo_allocno_class)
@@ -5486,7 +5482,7 @@ should use LRA, and existing ports are encouraged to convert.",
DEFHOOK
(register_priority,
"A target hook which returns the register priority number to which the\n\
-register @var{hard_regno} belongs to. The bigger the number, the\n\
+register :samp:`{hard_regno}` belongs to. The bigger the number, the\n\
more preferable the hard register usage (when all other conditions are\n\
the same). This hook can be used to prefer some hard register over\n\
others in LRA. For example, some x86-64 register usage needs\n\
@@ -5530,21 +5526,21 @@ The default version of this target hook returns always false.",
DEFHOOK
(spill_class,
"This hook defines a class of registers which could be used for spilling\n\
-pseudos of the given mode and class, or @code{NO_REGS} if only memory\n\
+pseudos of the given mode and class, or ``NO_REGS`` if only memory\n\
should be used. Not defining this hook is equivalent to returning\n\
-@code{NO_REGS} for all inputs.",
+``NO_REGS`` for all inputs.",
reg_class_t, (reg_class_t, machine_mode),
NULL)
/* Determine an additional allocno class. */
DEFHOOK
(additional_allocno_class_p,
- "This hook should return @code{true} if given class of registers should\n\
+ "This hook should return ``true`` if given class of registers should\n\
be an allocno class in any way. Usually RA uses only one register\n\
class from all classes containing the same register set. In some\n\
complicated cases, you need to have two or more such classes as\n\
allocno ones for RA correct work. Not defining this hook is\n\
-equivalent to returning @code{false} for all inputs.",
+equivalent to returning ``false`` for all inputs.",
bool, (reg_class_t),
hook_bool_reg_class_t_false)
@@ -5565,18 +5561,18 @@ DEFHOOK
"A target hook which lets a backend compute the set of pressure classes to\n\
be used by those optimization passes which take register pressure into\n\
account, as opposed to letting IRA compute them. It returns the number of\n\
-register classes stored in the array @var{pressure_classes}.",
+register classes stored in the array :samp:`{pressure_classes}`.",
int, (enum reg_class *pressure_classes), NULL)
/* True if a structure, union or array with MODE containing FIELD should
be accessed using BLKmode. */
DEFHOOK
(member_type_forces_blk,
- "Return true if a structure, union or array containing @var{field} should\n\
-be accessed using @code{BLKMODE}.\n\
+ "Return true if a structure, union or array containing :samp:`{field}` should\n\
+be accessed using ``BLKMODE``.\n\
\n\
-If @var{field} is the only field in the structure, @var{mode} is its\n\
-mode, otherwise @var{mode} is VOIDmode. @var{mode} is provided in the\n\
+If :samp:`{field}` is the only field in the structure, :samp:`{mode}` is its\n\
+mode, otherwise :samp:`{mode}` is VOIDmode. :samp:`{mode}` is provided in the\n\
case where structures of one field would require the structure's mode to\n\
retain the field's mode.\n\
\n\
@@ -5598,7 +5594,7 @@ DEFHOOK
(secondary_reload,
"Many machines have some registers that cannot be copied directly to or\n\
from memory or even from other types of registers. An example is the\n\
-@samp{MQ} register, which on most machines, can only be copied to or\n\
+:samp:`MQ` register, which on most machines, can only be copied to or\n\
from general registers, but not memory. Below, we shall be using the\n\
term 'intermediate register' when a move operation cannot be performed\n\
directly, but has to be done by copying the source into the intermediate\n\
@@ -5613,7 +5609,7 @@ Another kind of secondary reload is required on some machines which\n\
allow copying all registers to and from memory, but require a scratch\n\
register for stores to some memory locations (e.g., those with symbolic\n\
address on the RT, and those with certain symbolic address on the SPARC\n\
-when compiling PIC)@. Scratch registers need not have the same mode\n\
+when compiling PIC). Scratch registers need not have the same mode\n\
as the value being copied, and usually hold a different value than\n\
that being copied. Special patterns in the md file are needed to\n\
describe how the copy is performed with the help of the scratch register;\n\
@@ -5622,14 +5618,14 @@ of the scratch register(s).\n\
\n\
In some cases, both an intermediate and a scratch register are required.\n\
\n\
-For input reloads, this target hook is called with nonzero @var{in_p},\n\
-and @var{x} is an rtx that needs to be copied to a register of class\n\
-@var{reload_class} in @var{reload_mode}. For output reloads, this target\n\
-hook is called with zero @var{in_p}, and a register of class @var{reload_class}\n\
-needs to be copied to rtx @var{x} in @var{reload_mode}.\n\
+For input reloads, this target hook is called with nonzero :samp:`{in_p}`,\n\
+and :samp:`{x}` is an rtx that needs to be copied to a register of class\n\
+:samp:`{reload_class}` in :samp:`{reload_mode}`. For output reloads, this target\n\
+hook is called with zero :samp:`{in_p}`, and a register of class :samp:`{reload_class}`\n\
+needs to be copied to rtx :samp:`{x}` in :samp:`{reload_mode}`.\n\
\n\
-If copying a register of @var{reload_class} from/to @var{x} requires\n\
-an intermediate register, the hook @code{secondary_reload} should\n\
+If copying a register of :samp:`{reload_class}` from/to :samp:`{x}` requires\n\
+an intermediate register, the hook ``secondary_reload`` should\n\
return the register class required for this intermediate register.\n\
If no intermediate register is required, it should return NO_REGS.\n\
If more than one intermediate register is required, describe the one\n\
@@ -5639,46 +5635,54 @@ If scratch registers are needed, you also have to describe how to\n\
perform the copy from/to the reload register to/from this\n\
closest intermediate register. Or if no intermediate register is\n\
required, but still a scratch register is needed, describe the\n\
-copy from/to the reload register to/from the reload operand @var{x}.\n\
+copy from/to the reload register to/from the reload operand :samp:`{x}`.\n\
\n\
-You do this by setting @code{sri->icode} to the instruction code of a pattern\n\
+You do this by setting ``sri->icode`` to the instruction code of a pattern\n\
in the md file which performs the move. Operands 0 and 1 are the output\n\
and input of this copy, respectively. Operands from operand 2 onward are\n\
for scratch operands. These scratch operands must have a mode, and a\n\
single-register-class\n\
-@c [later: or memory]\n\
+\n\
+.. [later: or memory]\n\
+\n\
output constraint.\n\
\n\
-When an intermediate register is used, the @code{secondary_reload}\n\
+When an intermediate register is used, the ``secondary_reload``\n\
hook will be called again to determine how to copy the intermediate\n\
-register to/from the reload operand @var{x}, so your hook must also\n\
+register to/from the reload operand :samp:`{x}`, so your hook must also\n\
have code to handle the register class of the intermediate operand.\n\
\n\
-@c [For later: maybe we'll allow multi-alternative reload patterns -\n\
-@c the port maintainer could name a mov<mode> pattern that has clobbers -\n\
-@c and match the constraints of input and output to determine the required\n\
-@c alternative. A restriction would be that constraints used to match\n\
-@c against reloads registers would have to be written as register class\n\
-@c constraints, or we need a new target macro / hook that tells us if an\n\
-@c arbitrary constraint can match an unknown register of a given class.\n\
-@c Such a macro / hook would also be useful in other places.]\n\
+.. [For later: maybe we'll allow multi-alternative reload patterns -\n\
+\n\
+.. the port maintainer could name a mov<mode> pattern that has clobbers -\n\
+\n\
+.. and match the constraints of input and output to determine the required\n\
+\n\
+.. alternative. A restriction would be that constraints used to match\n\
\n\
+.. against reloads registers would have to be written as register class\n\
\n\
-@var{x} might be a pseudo-register or a @code{subreg} of a\n\
+.. constraints, or we need a new target macro / hook that tells us if an\n\
+\n\
+.. arbitrary constraint can match an unknown register of a given class.\n\
+\n\
+.. Such a macro / hook would also be useful in other places.]\n\
+\n\
+:samp:`{x}` might be a pseudo-register or a ``subreg`` of a\n\
pseudo-register, which could either be in a hard register or in memory.\n\
-Use @code{true_regnum} to find out; it will return @minus{}1 if the pseudo is\n\
+Use ``true_regnum`` to find out; it will return -1 if the pseudo is\n\
in memory and the hard register number if it is in a register.\n\
\n\
-Scratch operands in memory (constraint @code{\"=m\"} / @code{\"=&m\"}) are\n\
+Scratch operands in memory (constraint ``\"=m\"`` / ``\"=&m\"``) are\n\
currently not supported. For the time being, you will have to continue\n\
-to use @code{TARGET_SECONDARY_MEMORY_NEEDED} for that purpose.\n\
+to use ``TARGET_SECONDARY_MEMORY_NEEDED`` for that purpose.\n\
\n\
-@code{copy_cost} also uses this target hook to find out how values are\n\
+``copy_cost`` also uses this target hook to find out how values are\n\
copied. If you want it to include some extra cost for the need to allocate\n\
-(a) scratch register(s), set @code{sri->extra_cost} to the additional cost.\n\
+(a) scratch register(s), set ``sri->extra_cost`` to the additional cost.\n\
Or if two dependent moves are supposed to have a lower cost than the sum\n\
of the individual moves due to expected fortuitous scheduling and/or special\n\
-forwarding logic, you can set @code{sri->extra_cost} to a negative amount.",
+forwarding logic, you can set ``sri->extra_cost`` to a negative amount.",
reg_class_t,
(bool in_p, rtx x, reg_class_t reload_class, machine_mode reload_mode,
secondary_reload_info *sri),
@@ -5688,21 +5692,21 @@ DEFHOOK
(secondary_memory_needed,
"Certain machines have the property that some registers cannot be copied\n\
to some other registers without using memory. Define this hook on\n\
-those machines to return true if objects of mode @var{m} in registers\n\
-of @var{class1} can only be copied to registers of class @var{class2} by\n\
- storing a register of @var{class1} into memory and loading that memory\n\
-location into a register of @var{class2}. The default definition returns\n\
+those machines to return true if objects of mode :samp:`{m}` in registers\n\
+of :samp:`{class1}` can only be copied to registers of class :samp:`{class2}` by\n\
+storing a register of :samp:`{class1}` into memory and loading that memory\n\
+location into a register of :samp:`{class2}`. The default definition returns\n\
false for all inputs.",
bool, (machine_mode mode, reg_class_t class1, reg_class_t class2),
hook_bool_mode_reg_class_t_reg_class_t_false)
DEFHOOK
(secondary_memory_needed_mode,
- "If @code{TARGET_SECONDARY_MEMORY_NEEDED} tells the compiler to use memory\n\
-when moving between two particular registers of mode @var{mode},\n\
+ "If ``TARGET_SECONDARY_MEMORY_NEEDED`` tells the compiler to use memory\n\
+when moving between two particular registers of mode :samp:`{mode}`,\n\
this hook specifies the mode that the memory should have.\n\
\n\
-The default depends on @code{TARGET_LRA_P}. Without LRA, the default\n\
+The default depends on ``TARGET_LRA_P``. Without LRA, the default\n\
is to use a word-sized mode for integral modes that are smaller than a\n\
a word. This is right thing to do on most machines because it ensures\n\
that all bits of the register are copied and prevents accesses to the\n\
@@ -5713,10 +5717,10 @@ However, this default behavior is not correct on some machines, such as\n\
the DEC Alpha, that store short integers in floating-point registers\n\
differently than in integer registers. On those machines, the default\n\
widening will not work correctly and you must define this hook to\n\
-suppress that widening in some cases. See the file @file{alpha.cc} for\n\
+suppress that widening in some cases. See the file :samp:`alpha.cc` for\n\
details.\n\
\n\
-With LRA, the default is to use @var{mode} unmodified.",
+With LRA, the default is to use :samp:`{mode}` unmodified.",
machine_mode, (machine_mode mode),
default_secondary_memory_needed_mode)
@@ -5725,34 +5729,34 @@ With LRA, the default is to use @var{mode} unmodified.",
DEFHOOK
(preferred_reload_class,
"A target hook that places additional restrictions on the register class\n\
-to use when it is necessary to copy value @var{x} into a register in class\n\
-@var{rclass}. The value is a register class; perhaps @var{rclass}, or perhaps\n\
+to use when it is necessary to copy value :samp:`{x}` into a register in class\n\
+:samp:`{rclass}`. The value is a register class; perhaps :samp:`{rclass}`, or perhaps\n\
another, smaller class.\n\
\n\
-The default version of this hook always returns value of @code{rclass} argument.\n\
+The default version of this hook always returns value of ``rclass`` argument.\n\
\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on the 68000, when @var{x} is an integer constant that is in range\n\
-for a @samp{moveq} instruction, the value of this macro is always\n\
-@code{DATA_REGS} as long as @var{rclass} includes the data registers.\n\
-Requiring a data register guarantees that a @samp{moveq} will be used.\n\
-\n\
-One case where @code{TARGET_PREFERRED_RELOAD_CLASS} must not return\n\
-@var{rclass} is if @var{x} is a legitimate constant which cannot be\n\
-loaded into some register class. By returning @code{NO_REGS} you can\n\
-force @var{x} into a memory location. For example, rs6000 can load\n\
+example, on the 68000, when :samp:`{x}` is an integer constant that is in range\n\
+for a :samp:`moveq` instruction, the value of this macro is always\n\
+``DATA_REGS`` as long as :samp:`{rclass}` includes the data registers.\n\
+Requiring a data register guarantees that a :samp:`moveq` will be used.\n\
+\n\
+One case where ``TARGET_PREFERRED_RELOAD_CLASS`` must not return\n\
+:samp:`{rclass}` is if :samp:`{x}` is a legitimate constant which cannot be\n\
+loaded into some register class. By returning ``NO_REGS`` you can\n\
+force :samp:`{x}` into a memory location. For example, rs6000 can load\n\
immediate values into general-purpose registers, but does not have an\n\
instruction for loading an immediate value into a floating-point\n\
-register, so @code{TARGET_PREFERRED_RELOAD_CLASS} returns @code{NO_REGS} when\n\
-@var{x} is a floating-point constant. If the constant can't be loaded\n\
+register, so ``TARGET_PREFERRED_RELOAD_CLASS`` returns ``NO_REGS`` when\n\
+:samp:`{x}` is a floating-point constant. If the constant can't be loaded\n\
into any kind of register, code generation will be better if\n\
-@code{TARGET_LEGITIMATE_CONSTANT_P} makes the constant illegitimate instead\n\
-of using @code{TARGET_PREFERRED_RELOAD_CLASS}.\n\
+``TARGET_LEGITIMATE_CONSTANT_P`` makes the constant illegitimate instead\n\
+of using ``TARGET_PREFERRED_RELOAD_CLASS``.\n\
\n\
If an insn has pseudos in it after register allocation, reload will go\n\
-through the alternatives and call repeatedly @code{TARGET_PREFERRED_RELOAD_CLASS}\n\
-to find the best one. Returning @code{NO_REGS}, in this case, makes\n\
-reload add a @code{!} in front of the constraint: the x86 back-end uses\n\
+through the alternatives and call repeatedly ``TARGET_PREFERRED_RELOAD_CLASS``\n\
+to find the best one. Returning ``NO_REGS``, in this case, makes\n\
+reload add a ``!`` in front of the constraint: the x86 back-end uses\n\
this feature to discourage usage of 387 registers when math is done in\n\
the SSE registers (and vice versa).",
reg_class_t,
@@ -5763,14 +5767,14 @@ the SSE registers (and vice versa).",
input reloads. */
DEFHOOK
(preferred_output_reload_class,
- "Like @code{TARGET_PREFERRED_RELOAD_CLASS}, but for output reloads instead of\n\
+ "Like ``TARGET_PREFERRED_RELOAD_CLASS``, but for output reloads instead of\n\
input reloads.\n\
\n\
-The default version of this hook always returns value of @code{rclass}\n\
+The default version of this hook always returns value of ``rclass``\n\
argument.\n\
\n\
-You can also use @code{TARGET_PREFERRED_OUTPUT_RELOAD_CLASS} to discourage\n\
-reload from using some alternatives, like @code{TARGET_PREFERRED_RELOAD_CLASS}.",
+You can also use ``TARGET_PREFERRED_OUTPUT_RELOAD_CLASS`` to discourage\n\
+reload from using some alternatives, like ``TARGET_PREFERRED_RELOAD_CLASS``.",
reg_class_t,
(rtx x, reg_class_t rclass),
default_preferred_output_reload_class)
@@ -5783,19 +5787,19 @@ The early rematerialization pass can help in such cases by aggressively\n\
recomputing values after calls, so that they don't need to be spilled.\n\
\n\
This hook returns the set of such modes by setting the associated bits\n\
-in @var{modes}. The default implementation selects no modes, which has\n\
+in :samp:`{modes}`. The default implementation selects no modes, which has\n\
the effect of disabling the early rematerialization pass.",
void, (sbitmap modes),
default_select_early_remat_modes)
DEFHOOK
(class_likely_spilled_p,
- "A target hook which returns @code{true} if pseudos that have been assigned\n\
-to registers of class @var{rclass} would likely be spilled because\n\
-registers of @var{rclass} are needed for spill registers.\n\
+ "A target hook which returns ``true`` if pseudos that have been assigned\n\
+to registers of class :samp:`{rclass}` would likely be spilled because\n\
+registers of :samp:`{rclass}` are needed for spill registers.\n\
\n\
-The default version of this target hook returns @code{true} if @var{rclass}\n\
-has exactly one register and @code{false} otherwise. On most machines, this\n\
+The default version of this target hook returns ``true`` if :samp:`{rclass}`\n\
+has exactly one register and ``false`` otherwise. On most machines, this\n\
default should be used. For generally register-starved machines, such as\n\
i386, or machines with right register constraints, such as SH, this hook\n\
can be used to avoid excessive spilling.\n\
@@ -5811,18 +5815,18 @@ pressure.",
DEFHOOK
(class_max_nregs,
"A target hook returns the maximum number of consecutive registers\n\
-of class @var{rclass} needed to hold a value of mode @var{mode}.\n\
+of class :samp:`{rclass}` needed to hold a value of mode :samp:`{mode}`.\n\
\n\
-This is closely related to the macro @code{TARGET_HARD_REGNO_NREGS}.\n\
-In fact, the value returned by @code{TARGET_CLASS_MAX_NREGS (@var{rclass},\n\
-@var{mode})} target hook should be the maximum value of\n\
-@code{TARGET_HARD_REGNO_NREGS (@var{regno}, @var{mode})} for all @var{regno}\n\
-values in the class @var{rclass}.\n\
+This is closely related to the macro ``TARGET_HARD_REGNO_NREGS``.\n\
+In fact, the value returned by ``TARGET_CLASS_MAX_NREGS (rclass,\n\
+mode)`` target hook should be the maximum value of\n\
+``TARGET_HARD_REGNO_NREGS (regno, mode)`` for all :samp:`{regno}`\n\
+values in the class :samp:`{rclass}`.\n\
\n\
This target hook helps control the handling of multiple-word values\n\
in the reload pass.\n\
\n\
-The default version of this target hook returns the size of @var{mode}\n\
+The default version of this target hook returns the size of :samp:`{mode}`\n\
in words.",
unsigned char, (reg_class_t rclass, machine_mode mode),
default_class_max_nregs)
@@ -5831,13 +5835,13 @@ DEFHOOK
(preferred_rename_class,
"A target hook that places additional preference on the register\n\
class to use when it is necessary to rename a register in class\n\
-@var{rclass} to another class, or perhaps @var{NO_REGS}, if no\n\
-preferred register class is found or hook @code{preferred_rename_class}\n\
+:samp:`{rclass}` to another class, or perhaps :samp:`{NO_REGS}`, if no\n\
+preferred register class is found or hook ``preferred_rename_class``\n\
is not implemented.\n\
Sometimes returning a more restrictive class makes better code. For\n\
-example, on ARM, thumb-2 instructions using @code{LO_REGS} may be\n\
-smaller than instructions using @code{GENERIC_REGS}. By returning\n\
-@code{LO_REGS} from @code{preferred_rename_class}, code size can\n\
+example, on ARM, thumb-2 instructions using ``LO_REGS`` may be\n\
+smaller than instructions using ``GENERIC_REGS``. By returning\n\
+``LO_REGS`` from ``preferred_rename_class``, code size can\n\
be reduced.",
reg_class_t, (reg_class_t rclass),
default_preferred_rename_class)
@@ -5846,10 +5850,10 @@ be reduced.",
during register allocation. */
DEFHOOK
(cannot_substitute_mem_equiv_p,
- "A target hook which returns @code{true} if @var{subst} can't\n\
+ "A target hook which returns ``true`` if :samp:`{subst}` can't\n\
substitute safely pseudos with equivalent memory values during\n\
register allocation.\n\
-The default version of this target hook returns @code{false}.\n\
+The default version of this target hook returns ``false``.\n\
On most machines, this default should be used. For generally\n\
machines with non orthogonal register usage for addressing, such\n\
as SH, this hook can be used to avoid excessive spilling.",
@@ -5860,15 +5864,15 @@ as SH, this hook can be used to avoid excessive spilling.",
displacement addressing. */
DEFHOOK
(legitimize_address_displacement,
- "This hook tries to split address offset @var{orig_offset} into\n\
+ "This hook tries to split address offset :samp:`{orig_offset}` into\n\
two parts: one that should be added to the base address to create\n\
a local anchor point, and an additional offset that can be applied\n\
-to the anchor to address a value of mode @var{mode}. The idea is that\n\
+to the anchor to address a value of mode :samp:`{mode}`. The idea is that\n\
the local anchor could be shared by other accesses to nearby locations.\n\
\n\
The hook returns true if it succeeds, storing the offset of the\n\
-anchor from the base in @var{offset1} and the offset of the final address\n\
-from the anchor in @var{offset2}. The default implementation returns false.",
+anchor from the base in :samp:`{offset1}` and the offset of the final address\n\
+from the anchor in :samp:`{offset2}`. The default implementation returns false.",
bool, (rtx *offset1, rtx *offset2, poly_int64 orig_offset, machine_mode mode),
default_legitimize_address_displacement)
@@ -5898,48 +5902,49 @@ that are not actually in any insns yet, but will be later.",
DEFHOOK
(hard_regno_nregs,
"This hook returns the number of consecutive hard registers, starting\n\
-at register number @var{regno}, required to hold a value of mode\n\
-@var{mode}. This hook must never return zero, even if a register\n\
+at register number :samp:`{regno}`, required to hold a value of mode\n\
+:samp:`{mode}`. This hook must never return zero, even if a register\n\
cannot hold the requested mode - indicate that with\n\
-@code{TARGET_HARD_REGNO_MODE_OK} and/or\n\
-@code{TARGET_CAN_CHANGE_MODE_CLASS} instead.\n\
+``TARGET_HARD_REGNO_MODE_OK`` and/or\n\
+``TARGET_CAN_CHANGE_MODE_CLASS`` instead.\n\
\n\
-The default definition returns the number of words in @var{mode}.",
+The default definition returns the number of words in :samp:`{mode}`.",
unsigned int, (unsigned int regno, machine_mode mode),
default_hard_regno_nregs)
DEFHOOK
(hard_regno_mode_ok,
"This hook returns true if it is permissible to store a value\n\
-of mode @var{mode} in hard register number @var{regno} (or in several\n\
+of mode :samp:`{mode}` in hard register number :samp:`{regno}` (or in several\n\
registers starting with that one). The default definition returns true\n\
unconditionally.\n\
\n\
You need not include code to check for the numbers of fixed registers,\n\
because the allocation mechanism considers them to be always occupied.\n\
\n\
-@cindex register pairs\n\
+.. index:: register pairs\n\
+\n\
On some machines, double-precision values must be kept in even/odd\n\
register pairs. You can implement that by defining this hook to reject\n\
odd register numbers for such modes.\n\
\n\
The minimum requirement for a mode to be OK in a register is that the\n\
-@samp{mov@var{mode}} instruction pattern support moves between the\n\
+:samp:`mov{mode}` instruction pattern support moves between the\n\
register and other hard register in the same class and that moving a\n\
value into the register and back out not alter it.\n\
\n\
-Since the same instruction used to move @code{word_mode} will work for\n\
+Since the same instruction used to move ``word_mode`` will work for\n\
all narrower integer modes, it is not necessary on any machine for\n\
this hook to distinguish between these modes, provided you define\n\
-patterns @samp{movhi}, etc., to take advantage of this. This is\n\
-useful because of the interaction between @code{TARGET_HARD_REGNO_MODE_OK}\n\
-and @code{TARGET_MODES_TIEABLE_P}; it is very desirable for all integer\n\
+patterns :samp:`movhi`, etc., to take advantage of this. This is\n\
+useful because of the interaction between ``TARGET_HARD_REGNO_MODE_OK``\n\
+and ``TARGET_MODES_TIEABLE_P`` ; it is very desirable for all integer\n\
modes to be tieable.\n\
\n\
Many machines have special registers for floating point arithmetic.\n\
Often people assume that floating point machine modes are allowed only\n\
in floating point registers. This is not true. Any registers that\n\
-can hold integers can safely @emph{hold} a floating point machine\n\
+can hold integers can safely *hold* a floating point machine\n\
mode, whether or not floating arithmetic can be done on it in those\n\
registers. Integer move instructions can be used to move the values.\n\
\n\
@@ -5947,7 +5952,7 @@ On some machines, though, the converse is true: fixed-point machine\n\
modes may not go in floating registers. This is true if the floating\n\
registers normalize any value stored in them, because storing a\n\
non-floating value there would garble it. In this case,\n\
-@code{TARGET_HARD_REGNO_MODE_OK} should reject fixed-point machine modes in\n\
+``TARGET_HARD_REGNO_MODE_OK`` should reject fixed-point machine modes in\n\
floating registers. But if the floating registers do not automatically\n\
normalize, if you can store any bit pattern in one and retrieve it\n\
unchanged without a trap, then any machine mode may go in a floating\n\
@@ -5956,27 +5961,27 @@ register, so you can define this hook to say so.\n\
The primary significance of special floating registers is rather that\n\
they are the registers acceptable in floating point arithmetic\n\
instructions. However, this is of no concern to\n\
-@code{TARGET_HARD_REGNO_MODE_OK}. You handle it by writing the proper\n\
+``TARGET_HARD_REGNO_MODE_OK``. You handle it by writing the proper\n\
constraints for those instructions.\n\
\n\
On some machines, the floating registers are especially slow to access,\n\
so that it is better to store a value in a stack frame than in such a\n\
register if floating point arithmetic is not being done. As long as the\n\
-floating registers are not in class @code{GENERAL_REGS}, they will not\n\
+floating registers are not in class ``GENERAL_REGS``, they will not\n\
be used unless some pattern's constraint asks for one.",
bool, (unsigned int regno, machine_mode mode),
hook_bool_uint_mode_true)
DEFHOOK
(modes_tieable_p,
- "This hook returns true if a value of mode @var{mode1} is accessible\n\
-in mode @var{mode2} without copying.\n\
-\n\
-If @code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode1})} and\n\
-@code{TARGET_HARD_REGNO_MODE_OK (@var{r}, @var{mode2})} are always\n\
-the same for any @var{r}, then\n\
-@code{TARGET_MODES_TIEABLE_P (@var{mode1}, @var{mode2})}\n\
-should be true. If they differ for any @var{r}, you should define\n\
+ "This hook returns true if a value of mode :samp:`{mode1}` is accessible\n\
+in mode :samp:`{mode2}` without copying.\n\
+\n\
+If ``TARGET_HARD_REGNO_MODE_OK (r, mode1)`` and\n\
+``TARGET_HARD_REGNO_MODE_OK (r, mode2)`` are always\n\
+the same for any :samp:`{r}`, then\n\
+``TARGET_MODES_TIEABLE_P (mode1, mode2)``\n\
+should be true. If they differ for any :samp:`{r}`, you should define\n\
this hook to return false unless some other mechanism ensures the\n\
accessibility of the value in a narrower mode.\n\
\n\
@@ -5990,13 +5995,13 @@ allocation. The default definition returns true unconditionally.",
in peephole2. */
DEFHOOK
(hard_regno_scratch_ok,
- "This target hook should return @code{true} if it is OK to use a hard register\n\
-@var{regno} as scratch reg in peephole2.\n\
+ "This target hook should return ``true`` if it is OK to use a hard register\n\
+:samp:`{regno}` as scratch reg in peephole2.\n\
\n\
One common use of this macro is to prevent using of a register that\n\
is not saved by a prologue in an interrupt handler.\n\
\n\
-The default version of this hook always returns @code{true}.",
+The default version of this hook always returns ``true``.",
bool, (unsigned int regno),
default_hard_regno_scratch_ok)
@@ -6005,19 +6010,19 @@ DEFHOOK
"ABIs usually specify that calls must preserve the full contents\n\
of a particular register, or that calls can alter any part of a\n\
particular register. This information is captured by the target macro\n\
-@code{CALL_REALLY_USED_REGISTERS}. However, some ABIs specify that calls\n\
+``CALL_REALLY_USED_REGISTERS``. However, some ABIs specify that calls\n\
must preserve certain bits of a particular register but can alter others.\n\
This hook should return true if this applies to at least one of the\n\
-registers in @samp{(reg:@var{mode} @var{regno})}, and if as a result the\n\
-call would alter part of the @var{mode} value. For example, if a call\n\
-preserves the low 32 bits of a 64-bit hard register @var{regno} but can\n\
+registers in :samp:`(reg:{mode}{regno})`, and if as a result the\n\
+call would alter part of the :samp:`{mode}` value. For example, if a call\n\
+preserves the low 32 bits of a 64-bit hard register :samp:`{regno}` but can\n\
clobber the upper 32 bits, this hook should return true for a 64-bit mode\n\
but false for a 32-bit mode.\n\
\n\
-The value of @var{abi_id} comes from the @code{predefined_function_abi}\n\
+The value of :samp:`{abi_id}` comes from the ``predefined_function_abi``\n\
structure that describes the ABI of the call; see the definition of the\n\
structure for more details. If (as is usual) the target uses the same ABI\n\
-for all functions in a translation unit, @var{abi_id} is always 0.\n\
+for all functions in a translation unit, :samp:`{abi_id}` is always 0.\n\
\n\
The default implementation returns false, which is correct\n\
for targets that don't have partly call-clobbered registers.",
@@ -6036,7 +6041,7 @@ DEFHOOK
(case_values_threshold,
"This function return the smallest number of different values for which it\n\
is best to use a jump-table instead of a tree of conditional branches.\n\
-The default is four for machines with a @code{casesi} instruction and\n\
+The default is four for machines with a ``casesi`` instruction and\n\
five otherwise. This is best for most machines.",
unsigned int, (void),
default_case_values_threshold)
@@ -6044,9 +6049,9 @@ five otherwise. This is best for most machines.",
DEFHOOK
(starting_frame_offset,
"This hook returns the offset from the frame pointer to the first local\n\
-variable slot to be allocated. If @code{FRAME_GROWS_DOWNWARD}, it is the\n\
-offset to @emph{end} of the first slot allocated, otherwise it is the\n\
-offset to @emph{beginning} of the first slot allocated. The default\n\
+variable slot to be allocated. If ``FRAME_GROWS_DOWNWARD``, it is the\n\
+offset to *end* of the first slot allocated, otherwise it is the\n\
+offset to *beginning* of the first slot allocated. The default\n\
implementation returns 0.",
HOST_WIDE_INT, (void),
hook_hwi_void_0)
@@ -6056,7 +6061,7 @@ DEFHOOK
(compute_frame_layout,
"This target hook is called once each time the frame layout needs to be\n\
recalculated. The calculations can be cached by the target and can then\n\
-be used by @code{INITIAL_ELIMINATION_OFFSET} instead of re-computing the\n\
+be used by ``INITIAL_ELIMINATION_OFFSET`` instead of re-computing the\n\
layout on every invocation of that hook. This is particularly useful\n\
for targets that have an expensive frame layout function. Implementing\n\
this callback is optional.",
@@ -6066,28 +6071,28 @@ this callback is optional.",
/* Return true if a function must have and use a frame pointer. */
DEFHOOK
(frame_pointer_required,
- "This target hook should return @code{true} if a function must have and use\n\
+ "This target hook should return ``true`` if a function must have and use\n\
a frame pointer. This target hook is called in the reload pass. If its return\n\
-value is @code{true} the function will have a frame pointer.\n\
+value is ``true`` the function will have a frame pointer.\n\
\n\
This target hook can in principle examine the current function and decide\n\
-according to the facts, but on most machines the constant @code{false} or the\n\
-constant @code{true} suffices. Use @code{false} when the machine allows code\n\
+according to the facts, but on most machines the constant ``false`` or the\n\
+constant ``true`` suffices. Use ``false`` when the machine allows code\n\
to be generated with no frame pointer, and doing so saves some time or space.\n\
-Use @code{true} when there is no possible advantage to avoiding a frame\n\
+Use ``true`` when there is no possible advantage to avoiding a frame\n\
pointer.\n\
\n\
In certain cases, the compiler does not know how to produce valid code\n\
without a frame pointer. The compiler recognizes those cases and\n\
automatically gives the function a frame pointer regardless of what\n\
-@code{targetm.frame_pointer_required} returns. You don't need to worry about\n\
+``targetm.frame_pointer_required`` returns. You don't need to worry about\n\
them.\n\
\n\
In a function that does not require a frame pointer, the frame pointer\n\
register can be allocated for ordinary usage, unless you mark it as a\n\
-fixed register. See @code{FIXED_REGISTERS} for more information.\n\
+fixed register. See ``FIXED_REGISTERS`` for more information.\n\
\n\
-Default return value is @code{false}.",
+Default return value is ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6095,13 +6100,13 @@ Default return value is @code{false}.",
from-reg with register number to-reg. */
DEFHOOK
(can_eliminate,
- "This target hook should return @code{true} if the compiler is allowed to\n\
-try to replace register number @var{from_reg} with register number\n\
-@var{to_reg}. This target hook will usually be @code{true}, since most of the\n\
+ "This target hook should return ``true`` if the compiler is allowed to\n\
+try to replace register number :samp:`{from_reg}` with register number\n\
+:samp:`{to_reg}`. This target hook will usually be ``true``, since most of the\n\
cases preventing register elimination are things that the compiler already\n\
knows about.\n\
\n\
-Default return value is @code{true}.",
+Default return value is ``true``.",
bool, (const int from_reg, const int to_reg),
hook_bool_const_int_const_int_true)
@@ -6111,30 +6116,30 @@ Default return value is @code{true}.",
DEFHOOK
(conditional_register_usage,
"This hook may conditionally modify five variables\n\
-@code{fixed_regs}, @code{call_used_regs}, @code{global_regs},\n\
-@code{reg_names}, and @code{reg_class_contents}, to take into account\n\
+``fixed_regs``, ``call_used_regs``, ``global_regs``,\n\
+``reg_names``, and ``reg_class_contents``, to take into account\n\
any dependence of these register sets on target flags. The first three\n\
-of these are of type @code{char []} (interpreted as boolean vectors).\n\
-@code{global_regs} is a @code{const char *[]}, and\n\
-@code{reg_class_contents} is a @code{HARD_REG_SET}. Before the macro is\n\
-called, @code{fixed_regs}, @code{call_used_regs},\n\
-@code{reg_class_contents}, and @code{reg_names} have been initialized\n\
-from @code{FIXED_REGISTERS}, @code{CALL_USED_REGISTERS},\n\
-@code{REG_CLASS_CONTENTS}, and @code{REGISTER_NAMES}, respectively.\n\
-@code{global_regs} has been cleared, and any @option{-ffixed-@var{reg}},\n\
-@option{-fcall-used-@var{reg}} and @option{-fcall-saved-@var{reg}}\n\
+of these are of type ``char []`` (interpreted as boolean vectors).\n\
+``global_regs`` is a ``const char *[]``, and\n\
+``reg_class_contents`` is a ``HARD_REG_SET``. Before the macro is\n\
+called, ``fixed_regs``, ``call_used_regs``,\n\
+``reg_class_contents``, and ``reg_names`` have been initialized\n\
+from ``FIXED_REGISTERS``, ``CALL_USED_REGISTERS``,\n\
+``REG_CLASS_CONTENTS``, and ``REGISTER_NAMES``, respectively.\n\
+``global_regs`` has been cleared, and any :option:`-ffixed-reg`,\n\
+:option:`-fcall-used-reg` and :option:`-fcall-saved-reg`\n\
command options have been applied.\n\
\n\
-@cindex disabling certain registers\n\
-@cindex controlling register usage\n\
+.. index:: disabling certain registers, controlling register usage\n\
+\n\
If the usage of an entire class of registers depends on the target\n\
flags, you may indicate this to GCC by using this macro to modify\n\
-@code{fixed_regs} and @code{call_used_regs} to 1 for each of the\n\
-registers in the classes which should not be used by GCC@. Also make\n\
-@code{define_register_constraint}s return @code{NO_REGS} for constraints\n\
+``fixed_regs`` and ``call_used_regs`` to 1 for each of the\n\
+registers in the classes which should not be used by GCC. Also make\n\
+``define_register_constraint`` s return ``NO_REGS`` for constraints\n\
that shouldn't be used.\n\
\n\
-(However, if this class is not included in @code{GENERAL_REGS} and all\n\
+(However, if this class is not included in ``GENERAL_REGS`` and all\n\
of the insn patterns whose constraints permit this class are\n\
controlled by target switches, then GCC will automatically avoid using\n\
these registers when the target switches are opposed to them.)",
@@ -6171,24 +6176,28 @@ DEFHOOK_UNDOC
DEFHOOK
(excess_precision,
"Return a value, with the same meaning as the C99 macro\n\
-@code{FLT_EVAL_METHOD} that describes which excess precision should be\n\
-applied. @var{type} is either @code{EXCESS_PRECISION_TYPE_IMPLICIT},\n\
-@code{EXCESS_PRECISION_TYPE_FAST},\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, or\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}. For\n\
-@code{EXCESS_PRECISION_TYPE_IMPLICIT}, the target should return which\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied. :samp:`{type}` is either ``EXCESS_PRECISION_TYPE_IMPLICIT``,\n\
+``EXCESS_PRECISION_TYPE_FAST``,\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, or\n\
+``EXCESS_PRECISION_TYPE_FLOAT16``. For\n\
+``EXCESS_PRECISION_TYPE_IMPLICIT``, the target should return which\n\
precision and range operations will be implictly evaluated in regardless\n\
of the excess precision explicitly added. For\n\
-@code{EXCESS_PRECISION_TYPE_STANDARD}, \n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16}, and\n\
-@code{EXCESS_PRECISION_TYPE_FAST}, the target should return the\n\
+``EXCESS_PRECISION_TYPE_STANDARD``, \n\
+``EXCESS_PRECISION_TYPE_FLOAT16``, and\n\
+``EXCESS_PRECISION_TYPE_FAST``, the target should return the\n\
explicit excess precision that should be added depending on the\n\
-value set for @option{-fexcess-precision=@r{[}standard@r{|}fast@r{|}16@r{]}}.\n\
+value set for :option:`-fexcess-precision=[standard|fast|16]`.\n\
Note that unpredictable explicit excess precision does not make sense,\n\
-so a target should never return @code{FLT_EVAL_METHOD_UNPREDICTABLE}\n\
-when @var{type} is @code{EXCESS_PRECISION_TYPE_STANDARD},\n\
-@code{EXCESS_PRECISION_TYPE_FLOAT16} or\n\
-@code{EXCESS_PRECISION_TYPE_FAST}.",
+so a target should never return ``FLT_EVAL_METHOD_UNPREDICTABLE``\n\
+when :samp:`{type}` is ``EXCESS_PRECISION_TYPE_STANDARD``,\n\
+``EXCESS_PRECISION_TYPE_FLOAT16`` or\n\
+``EXCESS_PRECISION_TYPE_FAST``.\n\
+\n\
+Return a value, with the same meaning as the C99 macro\n\
+``FLT_EVAL_METHOD`` that describes which excess precision should be\n\
+applied.",
enum flt_eval_method, (enum excess_precision_type type),
default_excess_precision)
@@ -6212,8 +6221,8 @@ default is long_long_integer_type_node.",
DEFHOOK
(guard_mask_bit,
"This hook determines how guard variables are used. It should return\n\
-@code{false} (the default) if the first byte should be used. A return value of\n\
-@code{true} indicates that only the least significant bit should be used.",
+``false`` (the default) if the first byte should be used. A return value of\n\
+``true`` indicates that only the least significant bit should be used.",
bool, (void),
hook_bool_void_false)
@@ -6221,18 +6230,18 @@ DEFHOOK
DEFHOOK
(get_cookie_size,
"This hook returns the size of the cookie to use when allocating an array\n\
-whose elements have the indicated @var{type}. Assumes that it is already\n\
+whose elements have the indicated :samp:`{type}`. Assumes that it is already\n\
known that a cookie is needed. The default is\n\
-@code{max(sizeof (size_t), alignof(type))}, as defined in section 2.7 of the\n\
-IA64/Generic C++ ABI@.",
+``max(sizeof (size_t), alignof(type))``, as defined in section 2.7 of the\n\
+IA64/Generic C++ ABI.",
tree, (tree type),
default_cxx_get_cookie_size)
/* Returns true if the element size should be stored in the array cookie. */
DEFHOOK
(cookie_has_size,
- "This hook should return @code{true} if the element size should be stored in\n\
-array cookies. The default is to return @code{false}.",
+ "This hook should return ``true`` if the element size should be stored in\n\
+array cookies. The default is to return ``false``.",
bool, (void),
hook_bool_void_false)
@@ -6241,8 +6250,8 @@ array cookies. The default is to return @code{false}.",
DEFHOOK
(import_export_class,
"If defined by a backend this hook allows the decision made to export\n\
-class @var{type} to be overruled. Upon entry @var{import_export}\n\
-will contain 1 if the class is going to be exported, @minus{}1 if it is going\n\
+class :samp:`{type}` to be overruled. Upon entry :samp:`{import_export}`\n\
+will contain 1 if the class is going to be exported, -1 if it is going\n\
to be imported and 0 otherwise. This function should return the\n\
modified value and perform any other actions necessary to support the\n\
backend's targeted operating system.",
@@ -6251,9 +6260,9 @@ backend's targeted operating system.",
/* Returns true if constructors and destructors return "this". */
DEFHOOK
(cdtor_returns_this,
- "This hook should return @code{true} if constructors and destructors return\n\
+ "This hook should return ``true`` if constructors and destructors return\n\
the address of the object created/destroyed. The default is to return\n\
-@code{false}.",
+``false``.",
bool, (void),
hook_bool_void_false)
@@ -6268,18 +6277,18 @@ table to be emitted) may be an inline function. Under the standard\n\
Itanium C++ ABI the key method may be an inline function so long as\n\
the function is not declared inline in the class definition. Under\n\
some variants of the ABI, an inline function can never be the key\n\
-method. The default is to return @code{true}.",
+method. The default is to return ``true``.",
bool, (void),
hook_bool_void_true)
DEFHOOK
(determine_class_data_visibility,
-"@var{decl} is a virtual table, virtual table table, typeinfo object,\n\
+ ":samp:`{decl}` is a virtual table, virtual table table, typeinfo object,\n\
or other similar implicit class data object that will be emitted with\n\
external linkage in this translation unit. No ELF visibility has been\n\
explicitly specified. If the target needs to specify a visibility\n\
other than that of the containing class, use this hook to set\n\
-@code{DECL_VISIBILITY} and @code{DECL_VISIBILITY_SPECIFIED}.",
+``DECL_VISIBILITY`` and ``DECL_VISIBILITY_SPECIFIED``.",
void, (tree decl),
hook_void_tree)
@@ -6313,9 +6322,9 @@ be COMDAT, false if it should not be COMDAT.",
destructors. */
DEFHOOK
(use_aeabi_atexit,
- "This hook returns true if @code{__aeabi_atexit} (as defined by the ARM EABI)\n\
-should be used to register static destructors when @option{-fuse-cxa-atexit}\n\
-is in effect. The default is to return false to use @code{__cxa_atexit}.",
+ "This hook returns true if ``__aeabi_atexit`` (as defined by the ARM EABI)\n\
+should be used to register static destructors when :option:`-fuse-cxa-atexit`\n\
+is in effect. The default is to return false to use ``__cxa_atexit``.",
bool, (void),
hook_bool_void_false)
@@ -6323,9 +6332,9 @@ is in effect. The default is to return false to use @code{__cxa_atexit}.",
__cxa_atexit to register static destructors. */
DEFHOOK
(use_atexit_for_cxa_atexit,
- "This hook returns true if the target @code{atexit} function can be used\n\
-in the same manner as @code{__cxa_atexit} to register C++ static\n\
-destructors. This requires that @code{atexit}-registered functions in\n\
+ "This hook returns true if the target ``atexit`` function can be used\n\
+in the same manner as ``__cxa_atexit`` to register C++ static\n\
+destructors. This requires that ``atexit`` -registered functions in\n\
shared libraries are run in the correct order when the libraries are\n\
unloaded. The default is to return false.",
bool, (void),
@@ -6333,7 +6342,7 @@ unloaded. The default is to return false.",
DEFHOOK
(adjust_class_at_definition,
-"@var{type} is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
+ ":samp:`{type}` is a C++ class (i.e., RECORD_TYPE or UNION_TYPE) that has just\n\
been defined. Use this hook to make adjustments to the class (eg, tweak\n\
visibility or perform any other required target modifications).",
void, (tree type),
@@ -6341,7 +6350,7 @@ visibility or perform any other required target modifications).",
DEFHOOK
(decl_mangling_context,
- "Return target-specific mangling context of @var{decl} or @code{NULL_TREE}.",
+ "Return target-specific mangling context of :samp:`{decl}` or ``NULL_TREE``.",
tree, (const_tree decl),
hook_tree_const_tree_null)
@@ -6364,7 +6373,7 @@ DEFHOOKPOD
(register_common,
"Contains the name of the helper function that should be used at\n\
program startup to register TLS objects that are implicitly\n\
-initialized to zero. If this is @code{NULL}, all TLS objects will\n\
+initialized to zero. If this is ``NULL``, all TLS objects will\n\
have explicit initializers. The default causes libgcc's emulated TLS\n\
registration function to be used.",
const char *, "__builtin___emutls_register_common")
@@ -6373,14 +6382,14 @@ registration function to be used.",
DEFHOOKPOD
(var_section,
"Contains the name of the section in which TLS control variables should\n\
-be placed. The default of @code{NULL} allows these to be placed in\n\
+be placed. The default of ``NULL`` allows these to be placed in\n\
any section.",
const char *, NULL)
DEFHOOKPOD
(tmpl_section,
"Contains the name of the section in which TLS initializers should be\n\
-placed. The default of @code{NULL} allows these to be placed in any\n\
+placed. The default of ``NULL`` allows these to be placed in any\n\
section.",
const char *, NULL)
@@ -6388,22 +6397,22 @@ section.",
DEFHOOKPOD
(var_prefix,
"Contains the prefix to be prepended to TLS control variable names.\n\
-The default of @code{NULL} uses a target-specific prefix.",
+The default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
DEFHOOKPOD
(tmpl_prefix,
"Contains the prefix to be prepended to TLS initializer objects. The\n\
-default of @code{NULL} uses a target-specific prefix.",
+default of ``NULL`` uses a target-specific prefix.",
const char *, NULL)
/* Function to generate field definitions of the proxy variable. */
DEFHOOK
(var_fields,
"Specifies a function that generates the FIELD_DECLs for a TLS control\n\
-object type. @var{type} is the RECORD_TYPE the fields are for and\n\
-@var{name} should be filled with the structure tag, if the default of\n\
-@code{__emutls_object} is unsuitable. The default creates a type suitable\n\
+object type. :samp:`{type}` is the RECORD_TYPE the fields are for and\n\
+:samp:`{name}` should be filled with the structure tag, if the default of\n\
+``__emutls_object`` is unsuitable. The default creates a type suitable\n\
for libgcc's emulated TLS function.",
tree, (tree type, tree *name),
default_emutls_var_fields)
@@ -6412,8 +6421,8 @@ for libgcc's emulated TLS function.",
DEFHOOK
(var_init,
"Specifies a function that generates the CONSTRUCTOR to initialize a\n\
-TLS control object. @var{var} is the TLS control object, @var{decl}\n\
-is the TLS object and @var{tmpl_addr} is the address of the\n\
+TLS control object. :samp:`{var}` is the TLS control object, :samp:`{decl}`\n\
+is the TLS object and :samp:`{tmpl_addr}` is the address of the\n\
initializer. The default initializes libgcc's emulated TLS control object.",
tree, (tree var, tree decl, tree tmpl_addr),
default_emutls_var_init)
@@ -6430,7 +6439,7 @@ single objects. The default is false.",
/* Whether we can emit debug information for TLS vars. */
DEFHOOKPOD
(debug_form_tls_address,
- "Specifies whether a DWARF @code{DW_OP_form_tls_address} location descriptor\n\
+ "Specifies whether a DWARF ``DW_OP_form_tls_address`` location descriptor\n\
may be used to describe emulated TLS control objects.",
bool, false)
@@ -6445,15 +6454,15 @@ HOOK_VECTOR (TARGET_OPTION_HOOKS, target_option_hooks)
DECL_FUNCTION_SPECIFIC_TARGET in the function decl node. */
DEFHOOK
(valid_attribute_p,
- "This hook is called to parse @code{attribute(target(\"...\"))}, which\n\
+ "This hook is called to parse ``attribute(target(\"...\"))``, which\n\
allows setting target-specific options on individual functions.\n\
These function-specific options may differ\n\
from the options specified on the command line. The hook should return\n\
-@code{true} if the options are valid.\n\
+``true`` if the options are valid.\n\
\n\
-The hook should set the @code{DECL_FUNCTION_SPECIFIC_TARGET} field in\n\
+The hook should set the ``DECL_FUNCTION_SPECIFIC_TARGET`` field in\n\
the function declaration to hold a pointer to a target-specific\n\
-@code{struct cl_target_option} structure.",
+``struct cl_target_option`` structure.",
bool, (tree fndecl, tree name, tree args, int flags),
default_target_option_valid_attribute_p)
@@ -6461,9 +6470,9 @@ the function declaration to hold a pointer to a target-specific\n\
DEFHOOK
(save,
"This hook is called to save any additional target-specific information\n\
-in the @code{struct cl_target_option} structure for function-specific\n\
-options from the @code{struct gcc_options} structure.\n\
-@xref{Option file format}.",
+in the ``struct cl_target_option`` structure for function-specific\n\
+options from the ``struct gcc_options`` structure.\n\
+See :ref:`option-file-format`.",
void, (struct cl_target_option *ptr, struct gcc_options *opts,
struct gcc_options *opts_set), NULL)
@@ -6472,8 +6481,8 @@ options from the @code{struct gcc_options} structure.\n\
DEFHOOK
(restore,
"This hook is called to restore any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
-function-specific options to the @code{struct gcc_options} structure.",
+information in the ``struct cl_target_option`` structure for\n\
+function-specific options to the ``struct gcc_options`` structure.",
void, (struct gcc_options *opts, struct gcc_options *opts_set,
struct cl_target_option *ptr), NULL)
@@ -6482,7 +6491,7 @@ function-specific options to the @code{struct gcc_options} structure.",
DEFHOOK
(post_stream_in,
"This hook is called to update target-specific information in the\n\
-@code{struct cl_target_option} structure after it is streamed in from\n\
+``struct cl_target_option`` structure after it is streamed in from\n\
LTO bytecode.",
void, (struct cl_target_option *ptr), NULL)
@@ -6491,7 +6500,7 @@ LTO bytecode.",
DEFHOOK
(print,
"This hook is called to print any additional target-specific\n\
-information in the @code{struct cl_target_option} structure for\n\
+information in the ``struct cl_target_option`` structure for\n\
function-specific options.",
void, (FILE *file, int indent, struct cl_target_option *ptr), NULL)
@@ -6501,10 +6510,10 @@ function-specific options.",
true if the options are valid, and set the current state. */
DEFHOOK
(pragma_parse,
- "This target hook parses the options for @code{#pragma GCC target}, which\n\
+ "This target hook parses the options for ``#pragma GCC target``, which\n\
sets the target-specific options for functions that occur later in the\n\
input stream. The options accepted should be the same as those handled by the\n\
-@code{TARGET_OPTION_VALID_ATTRIBUTE_P} hook.",
+``TARGET_OPTION_VALID_ATTRIBUTE_P`` hook.",
bool, (tree args, tree pop_target),
default_target_option_pragma_parse)
@@ -6513,15 +6522,15 @@ DEFHOOK
(override,
"Sometimes certain combinations of command options do not make sense on\n\
a particular target machine. You can override the hook\n\
-@code{TARGET_OPTION_OVERRIDE} to take account of this. This hooks is called\n\
+``TARGET_OPTION_OVERRIDE`` to take account of this. This hooks is called\n\
once just after all the command options have been parsed.\n\
\n\
Don't use this hook to turn on various extra optimizations for\n\
-@option{-O}. That is what @code{TARGET_OPTION_OPTIMIZATION} is for.\n\
+:option:`-O`. That is what ``TARGET_OPTION_OPTIMIZATION`` is for.\n\
\n\
If you need to do something whenever the optimization level is\n\
changed via the optimize attribute or pragma, see\n\
-@code{TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE}",
+``TARGET_OVERRIDE_OPTIONS_AFTER_CHANGE``",
void, (void),
hook_void_void)
@@ -6531,8 +6540,8 @@ changed via the optimize attribute or pragma, see\n\
that is, they are compiled for different target machines. */
DEFHOOK
(function_versions,
- "This target hook returns @code{true} if @var{DECL1} and @var{DECL2} are\n\
-versions of the same function. @var{DECL1} and @var{DECL2} are function\n\
+ "This target hook returns ``true`` if :samp:`{DECL1}` and :samp:`{DECL2}` are\n\
+versions of the same function. :samp:`{DECL1}` and :samp:`{DECL2}` are function\n\
versions if and only if they have the same function signature and\n\
different target specific attributes, that is, they are compiled for\n\
different target machines.",
@@ -6544,8 +6553,8 @@ different target machines.",
#define HOOK_PREFIX "TARGET_"
DEFHOOK
(can_inline_p,
- "This target hook returns @code{false} if the @var{caller} function\n\
-cannot inline @var{callee}, based on target specific information. By\n\
+ "This target hook returns ``false`` if the :samp:`{caller}` function\n\
+cannot inline :samp:`{callee}`, based on target specific information. By\n\
default, inlining is not allowed if the callee function has function\n\
specific target options and the caller does not use the same options.",
bool, (tree caller, tree callee),
@@ -6561,9 +6570,9 @@ attributed by always_inline, but with the conservative analysis on all\n\
statements of the callee if we are able to guarantee the callee does not\n\
exploit any instructions from the mismatch isa feature, it would be safe to\n\
allow the caller to inline the callee.\n\
-@var{info} is one @code{unsigned int} value to record information in which\n\
+:samp:`{info}` is one ``unsigned int`` value to record information in which\n\
one set bit indicates one corresponding feature is detected in the analysis,\n\
-@var{stmt} is the statement being analyzed. Return true if target still\n\
+:samp:`{stmt}` is the statement being analyzed. Return true if target still\n\
need to analyze the subsequent statements, otherwise return false to stop\n\
subsequent analysis.\n\
The default version of this hook returns false.",
@@ -6574,12 +6583,12 @@ DEFHOOK
(need_ipa_fn_target_info,
"Allow target to check early whether it is necessary to analyze all gimple\n\
statements in the given function to update target specific information for\n\
-inlining. See hook @code{update_ipa_fn_target_info} for usage example of\n\
+inlining. See hook ``update_ipa_fn_target_info`` for usage example of\n\
target specific information. This hook is expected to be invoked ahead of\n\
-the iterating with hook @code{update_ipa_fn_target_info}.\n\
-@var{decl} is the function being analyzed, @var{info} is the same as what\n\
-in hook @code{update_ipa_fn_target_info}, target can do one time update\n\
-into @var{info} without iterating for some case. Return true if target\n\
+the iterating with hook ``update_ipa_fn_target_info``.\n\
+:samp:`{decl}` is the function being analyzed, :samp:`{info}` is the same as what\n\
+in hook ``update_ipa_fn_target_info``, target can do one time update\n\
+into :samp:`{info}` without iterating for some case. Return true if target\n\
decides to analyze all gimple statements to collect information, otherwise\n\
return false.\n\
The default version of this hook returns false.",
@@ -6588,7 +6597,7 @@ The default version of this hook returns false.",
DEFHOOK
(relayout_function,
-"This target hook fixes function @var{fndecl} after attributes are processed.\n\
+ "This target hook fixes function :samp:`{fndecl}` after attributes are processed.\n\
Default does nothing. On ARM, the default function's alignment is updated\n\
with the attribute target.",
void, (tree fndecl),
@@ -6601,7 +6610,7 @@ HOOK_VECTOR_END (target_option)
bits in the bitmap passed in. */
DEFHOOK
(extra_live_on_entry,
- "Add any hard registers to @var{regs} that are live on entry to the\n\
+ "Add any hard registers to :samp:`{regs}` that are live on entry to the\n\
function. This hook only needs to be defined to provide registers that\n\
cannot be found by examination of FUNCTION_ARG_REGNO_P, the callee saved\n\
registers, STATIC_CHAIN_INCOMING_REGNUM, STATIC_CHAIN_REGNUM,\n\
@@ -6618,7 +6627,7 @@ DEFHOOKPOD
"Set to true if each call that binds to a local definition explicitly\n\
clobbers or sets all non-fixed registers modified by performing the call.\n\
That is, by the call pattern itself, or by code that might be inserted by the\n\
-linker (e.g.@: stubs, veneers, branch islands), but not including those\n\
+linker (e.g. stubs, veneers, branch islands), but not including those\n\
modifiable by the callee. The affected registers may be mentioned explicitly\n\
in the call pattern, or included as clobbers in CALL_INSN_FUNCTION_USAGE.\n\
The default version of this hook is set to false. The purpose of this hook\n\
@@ -6651,28 +6660,28 @@ HOOK_VECTOR (TARGET_SHRINK_WRAP_HOOKS, shrink_wrap)
DEFHOOK
(get_separate_components,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components that can be separately shrink-wrapped in the current function.\n\
-Return @code{NULL} if the current function should not get any separate\n\
+Return ``NULL`` if the current function should not get any separate\n\
shrink-wrapping.\n\
-Don't define this hook if it would always return @code{NULL}.\n\
+Don't define this hook if it would always return ``NULL``.\n\
If it is defined, the other hooks in this group have to be defined as well.",
sbitmap, (void),
NULL)
DEFHOOK
(components_for_bb,
- "This hook should return an @code{sbitmap} with the bits set for those\n\
+ "This hook should return an ``sbitmap`` with the bits set for those\n\
components where either the prologue component has to be executed before\n\
-the @code{basic_block}, or the epilogue component after it, or both.",
+the ``basic_block``, or the epilogue component after it, or both.",
sbitmap, (basic_block),
NULL)
DEFHOOK
(disqualify_components,
- "This hook should clear the bits in the @var{components} bitmap for those\n\
-components in @var{edge_components} that the target cannot handle on edge\n\
-@var{e}, where @var{is_prologue} says if this is for a prologue or an\n\
+ "This hook should clear the bits in the :samp:`{components}` bitmap for those\n\
+components in :samp:`{edge_components}` that the target cannot handle on edge\n\
+:samp:`{e}`, where :samp:`{is_prologue}` says if this is for a prologue or an\n\
epilogue instead.",
void, (sbitmap components, edge e, sbitmap edge_components, bool is_prologue),
NULL)
@@ -6692,8 +6701,8 @@ DEFHOOK
DEFHOOK
(set_handled_components,
"Mark the components in the parameter as handled, so that the\n\
-@code{prologue} and @code{epilogue} named patterns know to ignore those\n\
-components. The target code should not hang on to the @code{sbitmap}, it\n\
+``prologue`` and ``epilogue`` named patterns know to ignore those\n\
+components. The target code should not hang on to the ``sbitmap``, it\n\
will be deleted after this call.",
void, (sbitmap),
NULL)
@@ -6707,13 +6716,13 @@ DEFHOOK
(debug_unwind_info,
"This hook defines the mechanism that will be used for describing frame\n\
unwind information to the debugger. Normally the hook will return\n\
-@code{UI_DWARF2} if DWARF 2 debug information is enabled, and\n\
-return @code{UI_NONE} otherwise.\n\
+``UI_DWARF2`` if DWARF 2 debug information is enabled, and\n\
+return ``UI_NONE`` otherwise.\n\
\n\
-A target may return @code{UI_DWARF2} even when DWARF 2 debug information\n\
+A target may return ``UI_DWARF2`` even when DWARF 2 debug information\n\
is disabled in order to always output DWARF 2 frame information.\n\
\n\
-A target may return @code{UI_TARGET} if it has ABI specified unwind tables.\n\
+A target may return ``UI_TARGET`` if it has ABI specified unwind tables.\n\
This will suppress generation of the normal debug frame unwind information.",
enum unwind_info_type, (void),
default_debug_unwind_info)
@@ -6732,7 +6741,7 @@ definitely does not advance the PC, and os the view number must not\n\
be reset; or zero to decide based on the estimated insn length.\n\
\n\
If insn length is to be regarded as reliable, set the hook to\n\
-@code{hook_int_rtx_insn_0}.",
+``hook_int_rtx_insn_0``.",
int, (rtx_insn *), NULL)
/* The code parameter should be of type enum rtx_code but this is not
@@ -6741,20 +6750,20 @@ DEFHOOK
(canonicalize_comparison,
"On some machines not all possible comparisons are defined, but you can\n\
convert an invalid comparison into a valid one. For example, the Alpha\n\
-does not have a @code{GT} comparison, but you can use an @code{LT}\n\
+does not have a ``GT`` comparison, but you can use an ``LT``\n\
comparison instead and swap the order of the operands.\n\
\n\
On such machines, implement this hook to do any required conversions.\n\
-@var{code} is the initial comparison code and @var{op0} and @var{op1}\n\
+:samp:`{code}` is the initial comparison code and :samp:`{op0}` and :samp:`{op1}`\n\
are the left and right operands of the comparison, respectively. If\n\
-@var{op0_preserve_value} is @code{true} the implementation is not\n\
-allowed to change the value of @var{op0} since the value might be used\n\
+:samp:`{op0_preserve_value}` is ``true`` the implementation is not\n\
+allowed to change the value of :samp:`{op0}` since the value might be used\n\
in RTXs which aren't comparisons. E.g. the implementation is not\n\
allowed to swap operands in that case.\n\
\n\
GCC will not assume that the comparison resulting from this macro is\n\
valid but will see if the resulting insn matches a pattern in the\n\
-@file{md} file.\n\
+:samp:`md` file.\n\
\n\
You need not to implement this hook if it would never change the\n\
comparison code or operands.",
@@ -6775,15 +6784,15 @@ More generally, define this hook on RISC architectures if you want the\n\
compiler to try using arithmetical operations setting the condition codes\n\
with a precision lower than the word precision.\n\
\n\
-You need not define this hook if @code{WORD_REGISTER_OPERATIONS} is not\n\
+You need not define this hook if ``WORD_REGISTER_OPERATIONS`` is not\n\
defined to 1.",
unsigned int, (void), default_min_arithmetic_precision)
DEFHOOKPOD
(atomic_test_and_set_trueval,
"This value should be set if the result written by\n\
-@code{atomic_test_and_set} is not exactly 1, i.e.@: the\n\
-@code{bool} @code{true}.",
+``atomic_test_and_set`` is not exactly 1, i.e. the\n\
+``bool`` ``true``.",
unsigned char, 1)
/* Return an unsigned int representing the alignment (in bits) of the atomic
@@ -6791,29 +6800,29 @@ DEFHOOKPOD
as needed. */
DEFHOOK
(atomic_align_for_mode,
-"If defined, this function returns an appropriate alignment in bits for an\n\
-atomic object of machine_mode @var{mode}. If 0 is returned then the\n\
+ "If defined, this function returns an appropriate alignment in bits for an\n\
+atomic object of machine_mode :samp:`{mode}`. If 0 is returned then the\n\
default alignment for the specified mode is used.",
unsigned int, (machine_mode mode),
hook_uint_mode_0)
DEFHOOK
(atomic_assign_expand_fenv,
-"ISO C11 requires atomic compound assignments that may raise floating-point\n\
+ "ISO C11 requires atomic compound assignments that may raise floating-point\n\
exceptions to raise exceptions corresponding to the arithmetic operation\n\
whose result was successfully stored in a compare-and-exchange sequence.\n\
-This requires code equivalent to calls to @code{feholdexcept},\n\
-@code{feclearexcept} and @code{feupdateenv} to be generated at\n\
+This requires code equivalent to calls to ``feholdexcept``,\n\
+``feclearexcept`` and ``feupdateenv`` to be generated at\n\
appropriate points in the compare-and-exchange sequence. This hook should\n\
-set @code{*@var{hold}} to an expression equivalent to the call to\n\
-@code{feholdexcept}, @code{*@var{clear}} to an expression equivalent to\n\
-the call to @code{feclearexcept} and @code{*@var{update}} to an expression\n\
-equivalent to the call to @code{feupdateenv}. The three expressions are\n\
-@code{NULL_TREE} on entry to the hook and may be left as @code{NULL_TREE}\n\
+set ``*hold`` to an expression equivalent to the call to\n\
+``feholdexcept``, ``*clear`` to an expression equivalent to\n\
+the call to ``feclearexcept`` and ``*update`` to an expression\n\
+equivalent to the call to ``feupdateenv``. The three expressions are\n\
+``NULL_TREE`` on entry to the hook and may be left as ``NULL_TREE``\n\
if no code is required in a particular place. The default implementation\n\
-leaves all three expressions as @code{NULL_TREE}. The\n\
-@code{__atomic_feraiseexcept} function from @code{libatomic} may be of use\n\
-as part of the code generated in @code{*@var{update}}.",
+leaves all three expressions as ``NULL_TREE``. The\n\
+``__atomic_feraiseexcept`` function from ``libatomic`` may be of use\n\
+as part of the code generated in ``*update``.",
void, (tree *hold, tree *clear, tree *update),
default_atomic_assign_expand_fenv)
@@ -6824,7 +6833,7 @@ as part of the code generated in @code{*@var{update}}.",
DEFHOOKPOD
(have_switchable_bss_sections,
"This flag is true if we can create zeroed data by switching to a BSS\n\
-section and then using @code{ASM_OUTPUT_SKIP} to allocate the space.\n\
+section and then using ``ASM_OUTPUT_SKIP`` to allocate the space.\n\
This is true on most ELF targets.",
bool, false)
@@ -6832,9 +6841,9 @@ This is true on most ELF targets.",
false if we're using collect2 for the job. */
DEFHOOKPOD
(have_ctors_dtors,
- "This value is true if the target supports some ``native'' method of\n\
+ "This value is true if the target supports some 'native' method of\n\
collecting constructors and destructors to be run at startup and exit.\n\
-It is false if we must use @command{collect2}.",
+It is false if we must use :command:`collect2`.",
bool, false)
/* True if the target wants DTORs to be run from cxa_atexit. */
@@ -6844,7 +6853,7 @@ DEFHOOKPOD
run from __cxa_atexit. If this is the case then, for each priority level,\n\
a new constructor will be entered that registers the destructors for that\n\
level with __cxa_atexit (and there will be no destructors emitted).\n\
-It is false the method implied by @code{have_ctors_dtors} is used.",
+It is false the method implied by ``have_ctors_dtors`` is used.",
bool, false)
/* True if thread-local storage is supported. */
@@ -6858,7 +6867,7 @@ The default value is false.",
DEFHOOKPOD
(have_srodata_section,
"Contains the value true if the target places read-only\n\
-``small data'' into a separate section. The default value is false.",
+'small data' into a separate section. The default value is false.",
bool, false)
/* True if EH frame info sections should be zero-terminated. */
@@ -6866,18 +6875,18 @@ DEFHOOKPOD
(terminate_dw2_eh_frame_info,
"Contains the value true if the target should add a zero word onto the\n\
end of a Dwarf-2 frame info section when used for exception handling.\n\
-Default value is false if @code{EH_FRAME_SECTION_NAME} is defined, and\n\
+Default value is false if ``EH_FRAME_SECTION_NAME`` is defined, and\n\
true otherwise.",
bool, true)
/* True if #NO_APP should be emitted at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_app_off,
- "If this flag is true, the text of the macro @code{ASM_APP_OFF} will be\n\
+ "If this flag is true, the text of the macro ``ASM_APP_OFF`` will be\n\
printed as the very first line in the assembly file, unless\n\
-@option{-fverbose-asm} is in effect. (If that macro has been defined\n\
+:option:`-fverbose-asm` is in effect. (If that macro has been defined\n\
to the empty string, this variable has no effect.) With the normal\n\
-definition of @code{ASM_APP_OFF}, the effect is to notify the GNU\n\
+definition of ``ASM_APP_OFF``, the effect is to notify the GNU\n\
assembler that it need not bother stripping comments or extra\n\
whitespace from its input. This allows it to work a bit faster.\n\
\n\
@@ -6890,9 +6899,9 @@ comments that will cause GAS to issue errors in NO_APP mode.",
at the beginning of assembly output. */
DEFHOOKPOD
(asm_file_start_file_directive,
- "If this flag is true, @code{output_file_directive} will be called\n\
+ "If this flag is true, ``output_file_directive`` will be called\n\
for the primary source file, immediately after printing\n\
-@code{ASM_APP_OFF} (if that is enabled). Most ELF assemblers expect\n\
+``ASM_APP_OFF`` (if that is enabled). Most ELF assemblers expect\n\
this to be done. The default is false.",
bool, false)
@@ -6900,15 +6909,15 @@ this to be done. The default is false.",
ARM EABI. The effects the encoding of function exception specifications. */
DEFHOOKPOD
(arm_eabi_unwinder,
- "This flag should be set to @code{true} on targets that use an ARM EABI\n\
-based unwinding library, and @code{false} on other targets. This effects\n\
+ "This flag should be set to ``true`` on targets that use an ARM EABI\n\
+based unwinding library, and ``false`` on other targets. This effects\n\
the format of unwinding tables, and how the unwinder in entered after\n\
-running a cleanup. The default is @code{false}.",
+running a cleanup. The default is ``false``.",
bool, false)
DEFHOOKPOD
(want_debug_pub_sections,
- "True if the @code{.debug_pubtypes} and @code{.debug_pubnames} sections\n\
+ "True if the ``.debug_pubtypes`` and ``.debug_pubnames`` sections\n\
should be emitted. These sections are not used on most platforms, and\n\
in particular GDB does not use them.",
bool, false)
@@ -6941,57 +6950,57 @@ HOOK_VECTOR (TARGET_TOGGLE_, mode_switching)
DEFHOOK
(emit,
- "Generate one or more insns to set @var{entity} to @var{mode}.\n\
-@var{hard_reg_live} is the set of hard registers live at the point where\n\
-the insn(s) are to be inserted. @var{prev_moxde} indicates the mode\n\
+ "Generate one or more insns to set :samp:`{entity}` to :samp:`{mode}`.\n\
+:samp:`{hard_reg_live}` is the set of hard registers live at the point where\n\
+the insn(s) are to be inserted. :samp:`{prev_moxde}` indicates the mode\n\
to switch from. Sets of a lower numbered entity will be emitted before\n\
sets of a higher numbered entity to a mode of the same or lower priority.",
void, (int entity, int mode, int prev_mode, HARD_REG_SET regs_live), NULL)
DEFHOOK
(needed,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If @code{OPTIMIZE_MODE_SWITCHING} is defined, you must define this macro\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If ``OPTIMIZE_MODE_SWITCHING`` is defined, you must define this macro\n\
to return an integer value not larger than the corresponding element\n\
-in @code{NUM_MODES_FOR_MODE_SWITCHING}, to denote the mode that @var{entity}\n\
-must be switched into prior to the execution of @var{insn}.",
+in ``NUM_MODES_FOR_MODE_SWITCHING``, to denote the mode that :samp:`{entity}`\n\
+must be switched into prior to the execution of :samp:`{insn}`.",
int, (int entity, rtx_insn *insn), NULL)
DEFHOOK
(after,
- "@var{entity} is an integer specifying a mode-switched entity.\n\
-If this macro is defined, it is evaluated for every @var{insn} during mode\n\
+ ":samp:`{entity}` is an integer specifying a mode-switched entity.\n\
+If this macro is defined, it is evaluated for every :samp:`{insn}` during mode\n\
switching. It determines the mode that an insn results\n\
in (if different from the incoming mode).",
int, (int entity, int mode, rtx_insn *insn), NULL)
DEFHOOK
(entry,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function entry.\n\
-If @code{TARGET_MODE_ENTRY} is defined then @code{TARGET_MODE_EXIT}\n\
+that :samp:`{entity}` is assumed to be switched to at function entry.\n\
+If ``TARGET_MODE_ENTRY`` is defined then ``TARGET_MODE_EXIT``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(exit,
- "If this macro is defined, it is evaluated for every @var{entity} that\n\
+ "If this macro is defined, it is evaluated for every :samp:`{entity}` that\n\
needs mode switching. It should evaluate to an integer, which is a mode\n\
-that @var{entity} is assumed to be switched to at function exit.\n\
-If @code{TARGET_MODE_EXIT} is defined then @code{TARGET_MODE_ENTRY}\n\
+that :samp:`{entity}` is assumed to be switched to at function exit.\n\
+If ``TARGET_MODE_EXIT`` is defined then ``TARGET_MODE_ENTRY``\n\
must be defined.",
int, (int entity), NULL)
DEFHOOK
(priority,
- "This macro specifies the order in which modes for @var{entity}\n\
+ "This macro specifies the order in which modes for :samp:`{entity}`\n\
are processed. 0 is the highest priority,\n\
-@code{NUM_MODES_FOR_MODE_SWITCHING[@var{entity}] - 1} the lowest.\n\
+``NUM_MODES_FOR_MODE_SWITCHING[entity] - 1`` the lowest.\n\
The value of the macro should be an integer designating a mode\n\
-for @var{entity}. For any fixed @var{entity}, @code{mode_priority}\n\
-(@var{entity}, @var{n}) shall be a bijection in 0 @dots{}\n\
-@code{num_modes_for_mode_switching[@var{entity}] - 1}.",
+for :samp:`{entity}`. For any fixed :samp:`{entity}`, ``mode_priority``\n\
+(:samp:`{entity}`, :samp:`{n}`) shall be a bijection in 0 ...\n\
+``num_modes_for_mode_switching[entity] - 1``.",
int, (int entity, int n), NULL)
HOOK_VECTOR_END (mode_switching)
@@ -7003,11 +7012,11 @@ HOOK_VECTOR (TARGET_MEMTAG_, memtag)
DEFHOOK
(can_tag_addresses,
"True if the backend architecture naturally supports ignoring some region\n\
-of pointers. This feature means that @option{-fsanitize=hwaddress} can\n\
+of pointers. This feature means that :option:`-fsanitize=hwaddress` can\n\
work.\n\
\n\
At preset, this feature does not support address spaces. It also requires\n\
-@code{Pmode} to be the same as @code{ptr_mode}.",
+``Pmode`` to be the same as ``ptr_mode``.",
bool, (), default_memtag_can_tag_addresses)
DEFHOOK
@@ -7020,9 +7029,9 @@ The default returns 8.",
DEFHOOK
(granule_size,
"Return the size in real memory that each byte in shadow memory refers to.\n\
-I.e. if a variable is @var{X} bytes long in memory, then this hook should\n\
-return the value @var{Y} such that the tag in shadow memory spans\n\
-@var{X}/@var{Y} bytes.\n\
+I.e. if a variable is :samp:`{X}` bytes long in memory, then this hook should\n\
+return the value :samp:`{Y}` such that the tag in shadow memory spans\n\
+:samp:`{X}` / :samp:`{Y}` bytes.\n\
\n\
Most variables will need to be aligned to this amount since two variables\n\
that are neighbors in memory and share a tag granule would need to share\n\
@@ -7033,19 +7042,19 @@ The default returns 16.",
DEFHOOK
(insert_random_tag,
- "Return an RTX representing the value of @var{untagged} but with a\n\
+ "Return an RTX representing the value of :samp:`{untagged}` but with a\n\
(possibly) random tag in it.\n\
-Put that value into @var{target} if it is convenient to do so.\n\
+Put that value into :samp:`{target}` if it is convenient to do so.\n\
This function is used to generate a tagged base for the current stack frame.",
rtx, (rtx untagged, rtx target), default_memtag_insert_random_tag)
DEFHOOK
(add_tag,
- "Return an RTX that represents the result of adding @var{addr_offset} to\n\
-the address in pointer @var{base} and @var{tag_offset} to the tag in pointer\n\
-@var{base}.\n\
+ "Return an RTX that represents the result of adding :samp:`{addr_offset}` to\n\
+the address in pointer :samp:`{base}` and :samp:`{tag_offset}` to the tag in pointer\n\
+:samp:`{base}`.\n\
The resulting RTX must either be a valid memory address or be able to get\n\
-put into an operand with @code{force_operand}.\n\
+put into an operand with ``force_operand``.\n\
\n\
Unlike other memtag hooks, this must return an expression and not emit any\n\
RTL.",
@@ -7054,24 +7063,24 @@ RTL.",
DEFHOOK
(set_tag,
- "Return an RTX representing @var{untagged_base} but with the tag @var{tag}.\n\
-Try and store this in @var{target} if convenient.\n\
-@var{untagged_base} is required to have a zero tag when this hook is called.\n\
-The default of this hook is to set the top byte of @var{untagged_base} to\n\
-@var{tag}.",
+ "Return an RTX representing :samp:`{untagged_base}` but with the tag :samp:`{tag}`.\n\
+Try and store this in :samp:`{target}` if convenient.\n\
+:samp:`{untagged_base}` is required to have a zero tag when this hook is called.\n\
+The default of this hook is to set the top byte of :samp:`{untagged_base}` to\n\
+:samp:`{tag}`.",
rtx, (rtx untagged_base, rtx tag, rtx target), default_memtag_set_tag)
DEFHOOK
(extract_tag,
- "Return an RTX representing the tag stored in @var{tagged_pointer}.\n\
-Store the result in @var{target} if it is convenient.\n\
+ "Return an RTX representing the tag stored in :samp:`{tagged_pointer}`.\n\
+Store the result in :samp:`{target}` if it is convenient.\n\
The default represents the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_extract_tag)
DEFHOOK
(untagged_pointer,
- "Return an RTX representing @var{tagged_pointer} with its tag set to zero.\n\
-Store the result in @var{target} if convenient.\n\
+ "Return an RTX representing :samp:`{tagged_pointer}` with its tag set to zero.\n\
+Store the result in :samp:`{target}` if convenient.\n\
The default clears the top byte of the original pointer.",
rtx, (rtx tagged_pointer, rtx target), default_memtag_untagged_pointer)
@@ -7106,7 +7115,7 @@ DEFHOOK
counters incremented by profiling and code-coverage events. The default\n\
value is 64, if the type size of long long is greater than 32, otherwise the\n\
default value is 32. A 64-bit type is recommended to avoid overflows of the\n\
-counters. If the @option{-fprofile-update=atomic} is used, then the\n\
+counters. If the :option:`-fprofile-update=atomic` is used, then the\n\
counters are incremented using atomic operations. Targets not supporting\n\
64-bit atomic operations may override the default value and request a 32-bit\n\
type.",
@@ -7117,7 +7126,7 @@ type.",
DEFHOOKPOD
(have_shadow_call_stack,
"This value is true if the target platform supports\n\
-@option{-fsanitize=shadow-call-stack}. The default value is false.",
+:option:`-fsanitize=shadow-call-stack`. The default value is false.",
bool, false)
/* Close the 'struct gcc_target' definition. */
^ permalink raw reply [flat|nested] 11+ messages in thread
end of thread, other threads:[~2022-11-08 14:42 UTC | newest]
Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-11-07 13:00 [gcc(refs/users/marxin/heads/sphinx-final)] sphinx: port .def files to RST Martin Liska
-- strict thread matches above, loose matches on Subject: below --
2022-11-08 14:42 Martin Liska
2022-11-08 14:35 Martin Liska
2022-11-08 14:34 Martin Liska
2022-11-08 12:06 Martin Liska
2022-11-08 11:38 Martin Liska
2022-11-08 10:20 Martin Liska
2022-11-07 14:33 Martin Liska
2022-11-07 14:19 Martin Liska
2022-11-07 14:06 Martin Liska
2022-11-07 12:37 Martin Liska
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).