aboutsummaryrefslogtreecommitdiff
path: root/gcc/target.def
diff options
context:
space:
mode:
authorMatthew Malcomson <matthew.malcomson@arm.com>2024-07-02 11:11:11 +0100
committerMatthew Malcomson <matthew.malcomson@arm.com>2024-07-02 14:39:23 +0100
commitfef7b8ce9029a0538d0c051b3100ed3deb544b2b (patch)
treec9af18c3f6444c881dc12b0eb04e2efeeead90d3 /gcc/target.def
parent9bd51351c175d345b8a9b3c19ba49ba358940272 (diff)
downloadgcc-fef7b8ce9029a0538d0c051b3100ed3deb544b2b.zip
gcc-fef7b8ce9029a0538d0c051b3100ed3deb544b2b.tar.gz
gcc-fef7b8ce9029a0538d0c051b3100ed3deb544b2b.tar.bz2
gcc: docs: Fix documentation of two hooks
The `function_attribute_inlinable_p` hook documentation described it returning the value if it is OK to inline the provided fndecl into "the current function". AFAICS This hook is only called when `current_function_decl` is the same as the `fndecl` argument that the hook is given, hence asking whether `fndecl` can be inlined into "the current function" doesn't seem relevant. Moreover from what I see no existing implementation of `function_attribute_inlinable_p` uses "the current function" in any way. Update the documentation to match this understanding. The `unspec_may_trap_p` documentation mentioned applying to either `unspec` or `unspec_volatile`. AFAICS this hook is only used for `unspec` codes since c84a808e493a, so I removed the mention of `unspec_volatile`. gcc/ChangeLog: * doc/tm.texi: Regenerated. * target.def (function_attribute_inlinable_p, unspec_may_trap_p): Update documentation.
Diffstat (limited to 'gcc/target.def')
-rw-r--r--gcc/target.def18
1 files changed, 8 insertions, 10 deletions
diff --git a/gcc/target.def b/gcc/target.def
index e6f4df9..ce4d1ec 100644
--- a/gcc/target.def
+++ b/gcc/target.def
@@ -2314,10 +2314,10 @@ attribute handlers. So far this only affects the @var{noinit} and\n\
DEFHOOK
(function_attribute_inlinable_p,
"@cindex inlining\n\
-This target hook returns @code{true} if it is OK to inline @var{fndecl}\n\
-into the current function, despite its having target-specific\n\
-attributes, @code{false} otherwise. By default, if a function has a\n\
-target specific attribute attached to it, it will not be inlined.",
+This target hook returns @code{false} if the target-specific attributes on\n\
+@var{fndecl} always block it getting inlined, @code{true} otherwise. By\n\
+default, if a function has a target specific attribute attached to it, it\n\
+will not be inlined.",
bool, (const_tree fndecl),
hook_bool_const_tree_false)
@@ -4067,12 +4067,10 @@ 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\
-passed along.",
+ "This target hook returns nonzero if @var{x}, an @code{unspec} might cause\n\
+a trap. Targets can use this hook to enhance precision of analysis for\n\
+@code{unspec} operations. You may call @code{may_trap_p_1} to analyze inner\n\
+elements of @var{x} in which case @var{flags} should be passed along.",
int, (const_rtx x, unsigned flags),
default_unspec_may_trap_p)