From: Richard Biener <rguenther@suse.de>
Date: Wed, 4 Oct 2023 09:19:10 +0000 (+0200)
Subject: ipa/111643 - clarify flatten attribute documentation
X-Git-Tag: basepoints/gcc-15~5735
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=ffbd7c3d0fd1b9b10ef5a0f2b2e64bd234620167;p=thirdparty%2Fgcc.git

ipa/111643 - clarify flatten attribute documentation

The following clarifies the flatten attribute documentation to mention
the inlining applies also to calls formed as part of inlining earlier
calls but not calls to the function itself.

	PR ipa/111643
	* doc/extend.texi (attribute flatten): Clarify.
---

diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index b4770f1a149a..645c76f23e9d 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -3109,7 +3109,9 @@ file descriptor opened with @code{O_RDONLY}.
 @cindex @code{flatten} function attribute
 @item flatten
 Generally, inlining into a function is limited.  For a function marked with
-this attribute, every call inside this function is inlined, if possible.
+this attribute, every call inside this function is inlined including the
+calls such inlining introduces to the function (but not recursive calls
+to the function itself), if possible.
 Functions declared with attribute @code{noinline} and similar are not
 inlined.  Whether the function itself is considered for inlining depends
 on its size and the current inlining parameters.