summaryrefslogtreecommitdiff
path: root/pod
diff options
context:
space:
mode:
authorNiko Tyni <ntyni@debian.org>2009-04-02 20:54:10 +0300
committerDavid Mitchell <davem@iabyn.com>2009-04-20 11:50:41 +0100
commit31f6f5aa00011d88da3c64e4e1cb9629c8334dda (patch)
tree42a3f480cb2e2c8cc289c4780501a1628661e1e6 /pod
parentdd0cfdaa8f18412a5bea90a5dd33b46569dea1c5 (diff)
downloadperl-31f6f5aa00011d88da3c64e4e1cb9629c8334dda.tar.gz
Clarify PERL_SYS_INIT3() usage.
As seen in [perl #64326] and <http://bugs.debian.org/522099>, the PERL_SYS_INIT3() documentation in perlembed.pod could be clearer about the macro arguments.
Diffstat (limited to 'pod')
-rw-r--r--pod/perlembed.pod4
1 files changed, 4 insertions, 0 deletions
diff --git a/pod/perlembed.pod b/pod/perlembed.pod
index 161e1ceff5..36da54f7fe 100644
--- a/pod/perlembed.pod
+++ b/pod/perlembed.pod
@@ -207,6 +207,10 @@ interpreter, and PERL_SYS_TERM() after you free your last interpreter.
Since PERL_SYS_INIT3() may change C<env>, it may be more appropriate to
provide C<env> as an argument to perl_parse().
+Also notice that no matter what arguments you pass to perl_parse(),
+PERL_SYS_INIT3() must be invoked on the C main() argc, argv and env and
+only once.
+
Now compile this program (I'll call it I<interp.c>) into an executable:
% cc -o interp interp.c `perl -MExtUtils::Embed -e ccopts -e ldopts`