From: Andi Kleen <ak@linux.intel.com>
To: gcc-patches@gnu.org
Cc: Andi Kleen <ak@linux.intel.com>
Subject: [PATCH v4 5/5] Add documentation for musttail attribute
Date: Fri, 2 Feb 2024 01:09:20 -0800 [thread overview]
Message-ID: <20240202091322.1898280-6-ak@linux.intel.com> (raw)
In-Reply-To: <20240202091322.1898280-1-ak@linux.intel.com>
gcc/ChangeLog:
* doc/extend.texi: Document [[musttail]]
---
gcc/doc/extend.texi | 16 ++++++++++++++++
1 file changed, 16 insertions(+)
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index 142e41ab8fbf..866f6c4a9fed 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -9875,6 +9875,22 @@ foo (int x, int y)
@code{y} is not actually incremented and the compiler can but does not
have to optimize it to just @code{return 42 + 42;}.
+@cindex @code{musttail} statement attribute
+@item musttail
+
+The @code{gnu::musttail} or @code{clang::musttail} attribute
+can be applied to a return statement that returns the value
+of a call to indicate that the call must be a tail call
+that does not allocate extra stack space.
+
+@smallexample
+[[gnu::musttail]] return foo();
+@end smallexample
+
+If the compiler cannot generate a tail call it will generate
+an error. Tail calls generally require enabling optimization.
+On some targets they may not be supported.
+
@end table
@node Attribute Syntax
--
2.43.0
next prev parent reply other threads:[~2024-02-02 9:13 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-02 9:09 Updated musttail patches Andi Kleen
2024-02-02 9:09 ` [PATCH v4 1/5] Improve must tail in RTL backend Andi Kleen
2024-02-02 9:09 ` [PATCH v4 2/5] C++: Support clang compatible [[musttail]] (PR83324) Andi Kleen
2024-02-02 9:09 ` [PATCH v4 3/5] C: Implement musttail attribute for returns Andi Kleen
2024-02-02 9:09 ` [PATCH v4 4/5] Add tests for C/C++ musttail attributes Andi Kleen
2024-02-02 11:01 ` Prathamesh Kulkarni
2024-02-02 14:50 ` Andi Kleen
2024-02-02 9:09 ` Andi Kleen [this message]
2024-02-04 4:35 ` [PATCH v4 5/5] Add documentation for musttail attribute Sandra Loosemore
2024-02-05 13:32 ` Andi Kleen
2024-02-02 13:18 ` Updated musttail patches Joseph Myers
2024-02-02 14:49 ` Andi Kleen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240202091322.1898280-6-ak@linux.intel.com \
--to=ak@linux.intel.com \
--cc=gcc-patches@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).