This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document a bunch of foo_nocontext functions
authorKarl Williamson <khw@cpan.org>
Sat, 18 Jul 2020 13:24:34 +0000 (07:24 -0600)
committerKarl Williamson <khw@cpan.org>
Mon, 24 Aug 2020 04:22:00 +0000 (22:22 -0600)
These just refer to foo's pod, with an explanation of 'nocontext'

embed.fnc
op.c
sv.c
util.c

index 81bf01b..3283af8 100644 (file)
--- a/embed.fnc
+++ b/embed.fnc
@@ -598,19 +598,19 @@ fTpre     |void   |noperl_die|NN const char* pat|...
 Tore   |void   |win32_croak_not_implemented|NN const char * fname
 #endif
 #if defined(PERL_IMPLICIT_CONTEXT)
-AfTrp  |void   |croak_nocontext|NULLOK const char* pat|...
-AfTrp  |OP*    |die_nocontext  |NULLOK const char* pat|...
+AdfTrp |void   |croak_nocontext|NULLOK const char* pat|...
+AdfTrp |OP*    |die_nocontext  |NULLOK const char* pat|...
 AfTp   |void   |deb_nocontext  |NN const char* pat|...
-AfTp   |char*  |form_nocontext |NN const char* pat|...
-AFTp   |void   |load_module_nocontext|U32 flags|NN SV* name|NULLOK SV* ver|...
-AfTp   |SV*    |mess_nocontext |NN const char* pat|...
-AfTp   |void   |warn_nocontext |NN const char* pat|...
+AdfTp  |char*  |form_nocontext |NN const char* pat|...
+AdFTp  |void   |load_module_nocontext|U32 flags|NN SV* name|NULLOK SV* ver|...
+AdfTp  |SV*    |mess_nocontext |NN const char* pat|...
+AdfTp  |void   |warn_nocontext |NN const char* pat|...
 AfTp   |void   |warner_nocontext|U32 err|NN const char* pat|...
-AfTp   |SV*    |newSVpvf_nocontext|NN const char *const pat|...
-AfTp   |void   |sv_catpvf_nocontext|NN SV *const sv|NN const char *const pat|...
-AfTp   |void   |sv_setpvf_nocontext|NN SV *const sv|NN const char *const pat|...
-AfTp   |void   |sv_catpvf_mg_nocontext|NN SV *const sv|NN const char *const pat|...
-AfTp   |void   |sv_setpvf_mg_nocontext|NN SV *const sv|NN const char *const pat|...
+AdfTp  |SV*    |newSVpvf_nocontext|NN const char *const pat|...
+AdfTp  |void   |sv_catpvf_nocontext|NN SV *const sv|NN const char *const pat|...
+AdfTp  |void   |sv_setpvf_nocontext|NN SV *const sv|NN const char *const pat|...
+AdfTp  |void   |sv_catpvf_mg_nocontext|NN SV *const sv|NN const char *const pat|...
+AdfTp  |void   |sv_setpvf_mg_nocontext|NN SV *const sv|NN const char *const pat|...
 AbfTpD |int    |fprintf_nocontext|NN PerlIO *stream|NN const char *format|...
 AbfTpD |int    |printf_nocontext|NN const char *format|...
 #endif
diff --git a/op.c b/op.c
index 38a55f9..8482c80 100644 (file)
--- a/op.c
+++ b/op.c
@@ -8910,6 +8910,11 @@ than C<use>.
 =for apidoc Amnh||PERL_LOADMOD_NOIMPORT
 =for apidoc Amnh||PERL_LOADMOD_IMPORT_OPS
 
+=for apidoc load_module_nocontext
+Like C<L</load_module>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut */
 
 void
diff --git a/sv.c b/sv.c
index da697b9..122497e 100644 (file)
--- a/sv.c
+++ b/sv.c
@@ -9586,6 +9586,11 @@ Perl_newSVpvf_nocontext(const char *const pat, ...)
 Creates a new SV and initializes it with the string formatted like
 C<sv_catpvf>.
 
+=for apidoc newSVpvf_nocontext
+Like C<L</newSVpvf>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -10801,6 +10806,11 @@ Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
 Works like C<sv_catpvf> but copies the text into the SV instead of
 appending it.  Does not handle 'set' magic.  See C<L</sv_setpvf_mg>>.
 
+=for apidoc sv_setpvf_nocontext
+Like C<L</sv_setpvf>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -10840,6 +10850,11 @@ Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
 
 Like C<sv_setpvf>, but also handles 'set' magic.
 
+=for apidoc sv_setpvf_mg_nocontext
+Like C<L</sv_setpvf_mg>>, but does not take a thread context (C<aTHX>)
+parameter, so is used in situations where the caller doesn't already have the
+thread context.
+
 =cut
 */
 
@@ -10927,6 +10942,11 @@ upgraded to UTF-8.  Handles 'get' magic, but not 'set' magic.  See
 C<L</sv_catpvf_mg>>.  If the original SV was UTF-8, the pattern should be
 valid UTF-8; if the original SV was bytes, the pattern should be too.
 
+=for apidoc sv_catpvf_nocontext
+Like C<L</sv_catpvf>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut */
 
 void
@@ -10966,6 +10986,11 @@ Perl_sv_vcatpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
 
 Like C<sv_catpvf>, but also handles 'set' magic.
 
+=for apidoc sv_catpvf_mg_nocontext
+Like C<L</sv_catpvf_mg>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
diff --git a/util.c b/util.c
index bd541f8..1f98d20 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1174,7 +1174,7 @@ string which is a duplicate of C<pv>.  The size of the string is
 determined by C<strlen()>, which means it may not contain embedded C<NUL>
 characters and must have a trailing C<NUL>.  To prevent memory leaks, the
 memory allocated for the new string needs to be freed when no longer needed.
-This can be done with the L</C<Safefree>> function, or
+This can be done with the C<L</Safefree>> function, or
 L<C<SAVEFREEPV>|perlguts/SAVEFREEPV(p)>.
 
 On some platforms, Windows for example, all allocated memory owned by a thread
@@ -1389,6 +1389,11 @@ Uses a single private buffer so if you want to format several strings you
 must explicitly copy the earlier strings away (and free the copies when you
 are done).
 
+=for apidoc form_nocontext
+Like C<L</form>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -1425,6 +1430,11 @@ Normally, the resulting message is returned in a new mortal SV.
 During global destruction a single SV may be shared between uses of
 this function.
 
+=for apidoc mess_nocontext
+Like C<L</mess>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -1716,6 +1726,11 @@ Behaves the same as L</croak_sv>, except for the return type.
 It should be used only where the C<OP *> return type is required.
 The function never actually returns.
 
+=for apidoc die_nocontext
+Like C<L</die>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -1826,6 +1841,11 @@ error message from arguments.  If you want to throw a non-string object,
 or build an error message in an SV yourself, it is preferable to use
 the L</croak_sv> function, which does not involve clobbering C<ERRSV>.
 
+=for apidoc croak_nocontext
+Like C<L</croak>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */
 
@@ -1969,7 +1989,7 @@ Perl_warn_sv(pTHX_ SV *baseex)
 
 This is an XS interface to Perl's C<warn> function.
 
-This is like L</C<warn>>, but C<args> are an encapsulated
+This is like C<L</warn>>, but C<args> are an encapsulated
 argument list.
 
 Unlike with L</vcroak>, C<pat> is not permitted to be null.
@@ -2001,6 +2021,11 @@ but this is subject to modification by a C<$SIG{__WARN__}> handler.
 
 Unlike with L</croak>, C<pat> is not permitted to be null.
 
+=for apidoc warn_nocontext
+Like C<L</warn>> but does not take a thread context (C<aTHX>) parameter,
+so is used in situations where the caller doesn't already have the thread
+context.
+
 =cut
 */