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.
This commit is contained in:
parent
8dc319eb49
commit
c8874c5e8a
4 changed files with 1698 additions and 1689 deletions
|
@ -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\
|
||||
|
|
|
@ -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.",
|
||||
|
|
|
@ -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. */
|
||||
|
|
3299
gcc/target.def
3299
gcc/target.def
File diff suppressed because it is too large
Load diff
Loading…
Add table
Reference in a new issue