This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document PERL_USE_GCC_BRACE_GROUPS
authorKarl Williamson <khw@cpan.org>
Sat, 18 Jul 2020 13:13:29 +0000 (07:13 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 23 Aug 2020 02:42:41 +0000 (20:42 -0600)
perl.h

diff --git a/perl.h b/perl.h
index 4f1a9e3..33389d4 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -648,6 +648,15 @@ out of them.
 
 =for apidoc AmnUhu|void|STMT_END
 
+=for apidoc AmnuU|bool|PERL_USE_GCC_BRACE_GROUPS
+
+This C pre-processor value, if defined, indicates that it is permissible to use
+the GCC brace groups extension.  This extension is of the form C<({
+I<STATEMENTS> })>, and turns the block consisting of I<STATEMENTS> into an
+expression with a value, unlike plain C language blocks.  This can present
+optimization possibilities, but there always needs to be an alternative in case
+this ability doesn't exist or has otherwise been forbidden.
+
 =cut
 
  Trying to select a version that gives no warnings...