From: Karl Williamson <khw@cpan.org>
Date: Fri, 9 Jun 2017 20:21:01 +0000 (-0600)
Subject: embed.fnc: Add some comments
X-Git-Tag: v5.27.1~28
X-Git-Url: https://perl5.git.perl.org/perl5.git/commitdiff_plain/59f80a355333d79f772276049e38ca6e91f4a437?ds=inline

embed.fnc: Add some comments
---

diff --git a/embed.fnc b/embed.fnc
index 832d96b..fd59c72 100644
--- a/embed.fnc
+++ b/embed.fnc
@@ -124,6 +124,12 @@
 :
 :   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: