This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
embed.fnc: Add some comments
authorKarl Williamson <khw@cpan.org>
Fri, 9 Jun 2017 20:21:01 +0000 (14:21 -0600)
committerKarl Williamson <khw@cpan.org>
Wed, 14 Jun 2017 17:08:24 +0000 (11:08 -0600)
embed.fnc

index 832d96b..fd59c72 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
 :
 :   o  Has no Perl_foo or S_foo compatibility macro:
 :
 :
 :   o  Has no Perl_foo or S_foo compatibility macro:
 :
+:      This can be used when you define a macro with this entry's name that
+:      doesn't call the function specified by this entry.  This is typically
+:      done for a function that effectively just wraps another one, and where
+:      the macro form calls the underlying function directly.  For these, also
+:      specify the 'm' flag.  Legacy-only functions should instead use 'b'.
+:
 :         embed.h: suppress "#define foo Perl_foo"
 :
 :   P  Pure function:
 :         embed.h: suppress "#define foo Perl_foo"
 :
 :   P  Pure function: