In perl.git, the branch blead has been updated
<https://perl5.git.perl.org/perl.git/commitdiff/4510b393500f9f3cd77fafbbee5bdd37be8e4594?hp=6e23836a54f586418eb81fac4af911e6d883ab19>
- Log -----------------------------------------------------------------
commit 4510b393500f9f3cd77fafbbee5bdd37be8e4594
Merge: 6e23836a54 8008a6e6e6
Author: Tony Cook <t...@develop-help.com>
Date: Thu Aug 8 15:56:58 2019 +1000
APIify and document several interpreter variables
commit 8008a6e6e60e5971898f3f85b5566c9e4663699e
Author: Tony Cook <t...@develop-help.com>
Date: Thu Aug 8 15:53:31 2019 +1000
PERL_DESTRUCT_LEVEL no longer requires a -DDEBUGGING build
commit daf9aebe705685e1b0afbe8377bd4653693c895d
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 15:39:39 2019 +1100
(perl #132777) APIify and document PL_perl_destruct_level
This is documented in perlembed. It's only rarely used on CPAN
but it's pretty basic.
commit a902610b4b293074eeab256998987b8e1215585e
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 15:25:05 2019 +1100
(perl #132777) document (sort of) and APIify PL_runops
This is documented in perlguts in such a way that it appears be
effectively API, so APIify it.
It's used on CPAN in a small number of modules.
commit aa9ca194904d89c40a907b6b8e2e2bc71a17952e
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 15:06:41 2019 +1100
(perl #132777) document and APIify PL_parser
Used in a few places on CPAN, either to check or modify the
compilation error count, or to do a little parsing via bufptr.
commit 1172c104c90af393d8285157cc149375f71f636e
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 14:52:14 2019 +1100
(perl #132777) document and APIify PL_defgv
This is used occasionally on CPAN, typically to access $_.
commit c07b34e4260456bf87b544335b4a7b05f2a856c6
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 14:35:52 2019 +1100
(perl #132777) APIify and document PL_curstash
per leont: I can't think of any reason not to make PL_curstash API,
it's both common, useful, simple, and highly unlikely to ever need
change.
commit 20fbb8c297b88a2b4ad0fb679a190392299d875b
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 14:04:52 2019 +1100
(perl #132777) document and add PL_curcop to the API
PL_curcop is used fairly widely on CPAN, mostly to get the current
line number and file, to check lexical hints, or to check the
stash.
commit 7b93aae2da4ca7f9087e33fb273354900e2f372e
Author: Tony Cook <t...@develop-help.com>
Date: Thu Jan 31 13:37:44 2019 +1100
(perl #132777) document PL_exit_flags
PL_exit_flags is referred to in perlembed, perldiag and two
perldeltas, so APIify and document it.
-----------------------------------------------------------------------
Summary of changes:
intrpvar.h | 95 +++++++++++++++++++++++++++++++++++++++++++++++++++++++--
pod/perlrun.pod | 3 +-
2 files changed, 94 insertions(+), 4 deletions(-)
diff --git a/intrpvar.h b/intrpvar.h
index 41aa364329..93357eeadc 100644
--- a/intrpvar.h
+++ b/intrpvar.h
@@ -93,6 +93,14 @@ PERLVARI(I, tainted, bool, FALSE) /* using variables
controlled by $< */
*/
PERLVAR(I, delaymagic, U16) /* ($<,$>) = ... */
+/*
+=for apidoc Amn|GV *|PL_defgv
+
+The GV representing C<*_>. Useful for access to C<$_>.
+
+=cut
+*/
+
PERLVAR(I, localizing, U8) /* are we processing a local() list? */
PERLVAR(I, in_eval, U8) /* trap "fatal" errors? */
PERLVAR(I, defgv, GV *) /* the *_ glob */
@@ -117,11 +125,27 @@ PERLVAR(I, dowarn, U8)
PERLVARI(I, utf8cache, I8, PERL___I) /* Is the utf8 caching code enabled? */
#undef PERL___I
+/*
+=for apidoc Amn|HV*|PL_curstash
+
+The stash for the package code will be compiled into.
+
+=cut
+*/
/* Stashes */
PERLVAR(I, defstash, HV *) /* main symbol table */
PERLVAR(I, curstash, HV *) /* symbol table for current package */
+/*
+=for apidoc Amn|COP*|PL_curcop
+
+The currently active COP (control op) roughly representing the current
+statement in the source.
+
+=cut
+*/
+
PERLVAR(I, curcop, COP *)
PERLVAR(I, curstack, AV *) /* THE STACK */
PERLVAR(I, curstackinfo, PERL_SI *) /* current stack + context */
@@ -182,6 +206,14 @@ PERLVAR(I, padname_undef, PADNAME)
PERLVAR(I, padname_const, PADNAME)
PERLVAR(I, Sv, SV *) /* used to hold temporary values */
+/*
+=for apidoc Amn|yy_parser*|PL_parser
+
+The parser state when compiling code.
+
+=cut
+*/
+
PERLVAR(I, parser, yy_parser *) /* current parser state */
PERLVAR(I, stashcache, HV *) /* Cache to speed up S_method_common */
@@ -257,6 +289,37 @@ PERLVAR(I, efloatsize, STRLEN)
PERLVARI(I, dumpindent, U16, 4) /* number of blanks per dump
indentation level */
+/*
+=for apidoc Amn|U8|PL_exit_flags
+
+Contains flags controlling perl's behaviour on exit():
+
+=over
+
+=item * C<PERL_EXIT_DESTRUCT_END>
+
+If set, END blocks are executed when the interpreter is destroyed.
+This is normally set by perl itself after the interpreter is
+constructed.
+
+=item * C<PERL_EXIT_ABORT>
+
+Call C<abort()> on exit. This is used internally by perl itself to
+abort if exit is called while processing exit.
+
+=item * C<PERL_EXIT_WARN>
+
+Warn on exit.
+
+=item * C<PERL_EXIT_EXPECTED>
+
+Set by the L<perlfunc/exit> operator.
+
+=back
+
+=cut
+*/
+
PERLVAR(I, exit_flags, U8) /* was exit() unexpected, etc. */
PERLVAR(I, utf8locale, bool) /* utf8 locale detected */
@@ -565,6 +628,14 @@ PERLVAR(I, debug, volatile U32) /* flags given to -D
switch */
PERLVARI(I, padlist_generation, U32, 1) /* id to identify padlist
clones */
+/*
+=for apidoc Amn|runops_proc_t|PL_runops
+
+See L<perlguts/Pluggable runops>.
+
+=cut
+*/
+
PERLVARI(I, runops, runops_proc_t, RUNOPS_DEFAULT)
PERLVAR(I, subname, SV *) /* name of current subroutine */
@@ -619,8 +690,28 @@ PERLVARI(I, phase, enum perl_phase, PERL_PHASE_CONSTRUCT)
PERLVARI(I, in_load_module, bool, FALSE) /* to prevent recursions in
PerlIO_find_layer */
-/* This value may be set when embedding for full cleanup */
-/* 0=none, 1=full, 2=full with checks */
+/*
+=for apidoc Amn|signed char|PL_perl_destruct_level
+
+This value may be set when embedding for full cleanup.
+
+Possible values:
+
+=over
+
+=item * 0 - none
+
+=item * 1 - full
+
+=item * 2 or greater - full with checks.
+
+=back
+
+If C<$ENV{PERL_DESTRUCT_LEVEL}> is set to an integer greater than the
+value of C<PL_perl_destruct_level> its value is used instead.
+
+=cut
+*/
/* mod_perl is special, and also assigns a meaning -1 */
PERLVARI(I, perl_destruct_level, signed char, 0)
diff --git a/pod/perlrun.pod b/pod/perlrun.pod
index 9a27fac655..2a32976c01 100644
--- a/pod/perlrun.pod
+++ b/pod/perlrun.pod
@@ -1257,8 +1257,7 @@ after compilation.
=item PERL_DESTRUCT_LEVEL
X<PERL_DESTRUCT_LEVEL>
-Relevant only if your Perl executable was built with B<-DDEBUGGING>,
-this controls the behaviour of global destruction of objects and other
+Controls the behaviour of global destruction of objects and other
references. See L<perlhacktips/PERL_DESTRUCT_LEVEL> for more information.
=item PERL_DL_NONLAZY
--
Perl5 Master Repository
