diff options
author | Marcus Holland-Moritz <mhx-perl@gmx.net> | 2003-11-02 23:24:28 +0100 |
---|---|---|
committer | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2003-11-02 20:40:47 +0000 |
commit | dc9b1d22fd894bd3f8cd8578ad6e29d34151f62c (patch) | |
tree | 4e0b0c9690b455cbdce69a7c38782144ad024631 | |
parent | aed365b8e85ee97e966e49d61b9a9bc572b94d26 (diff) | |
download | perl-dc9b1d22fd894bd3f8cd8578ad6e29d34151f62c.tar.gz |
update embed.pl description
From: "Marcus Holland-Moritz" <mhx-perl@gmx.net>
Message-ID: <007b01c3a187$b34c6110$0c2f1fac@R2D2>
p4raw-id: //depot/perl@21627
-rw-r--r-- | pod/perlguts.pod | 38 |
1 files changed, 26 insertions, 12 deletions
diff --git a/pod/perlguts.pod b/pod/perlguts.pod index 3d1e5d82d0..4b571b788a 100644 --- a/pod/perlguts.pod +++ b/pod/perlguts.pod @@ -2085,11 +2085,12 @@ static functions start with C<S_>.) Inside the Perl core, you can get at the functions either with or without the C<Perl_> prefix, thanks to a bunch of defines that live in F<embed.h>. This header file is generated automatically from -F<embed.pl>. F<embed.pl> also creates the prototyping header files for -the internal functions, generates the documentation and a lot of other -bits and pieces. It's important that when you add a new function to the -core or change an existing one, you change the data in the table at the -end of F<embed.pl> as well. Here's a sample entry from that table: +F<embed.pl> and F<embed.fnc>. F<embed.pl> also creates the prototyping +header files for the internal functions, generates the documentation +and a lot of other bits and pieces. It's important that when you add +a new function to the core or change an existing one, you change the +data in the table in F<embed.fnc> as well. Here's a sample entry from +that table: Apd |SV** |av_fetch |AV* ar|I32 key|I32 lval @@ -2148,19 +2149,32 @@ or disappear without notice. This function should not have a compatibility macro to define, say, C<Perl_parse> to C<parse>. It must be called as C<Perl_parse>. -=item j - -This function is not a member of C<CPerlObj>. If you don't know -what this means, don't use it. - =item x This function isn't exported out of the Perl core. +=item m + +This is implemented as a macro. + +=item X + +This function is explicitly exported. + +=item E + +This function is visible to extensions included in the Perl core. + +=item b + +Binary backward compatibility; this function is a macro but also has +a C<Perl_> implementation (which is exported). + =back -If you edit F<embed.pl>, you will need to run C<make regen_headers> to -force a rebuild of F<embed.h> and other auto-generated files. +If you edit F<embed.pl> or F<embed.fnc>, you will need to run +C<make regen_headers> to force a rebuild of F<embed.h> and other +auto-generated files. =head2 Formatted Printing of IVs, UVs, and NVs |