summaryrefslogtreecommitdiff
path: root/sv.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-09-05 22:03:24 -0600
committerKarl Williamson <khw@cpan.org>2020-11-21 11:44:18 -0700
commit52394dc7f1db99c6f7412d0671f6e83a5fe4b3c1 (patch)
tree97b168befaf7c549cfa743b44dd5294543b26f90 /sv.c
parent73d434eae8af19f8e3477952dc0351abe0c561a7 (diff)
downloadperl-52394dc7f1db99c6f7412d0671f6e83a5fe4b3c1.tar.gz
perlapi: Consolidate sv_setpvf-ish entries
Diffstat (limited to 'sv.c')
-rw-r--r--sv.c32
1 files changed, 13 insertions, 19 deletions
diff --git a/sv.c b/sv.c
index 507df88829..8d95f79ba1 100644
--- a/sv.c
+++ b/sv.c
@@ -10756,14 +10756,21 @@ Perl_sv_setpvf_mg_nocontext(SV *const sv, const char *const pat, ...)
/*
=for apidoc sv_setpvf
+=for apidoc_item sv_setpvf_nocontext
+=for apidoc_item sv_setpvf_mg
+=for apidoc_item sv_setpvf_mg_nocontext
-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>>.
+These work like C<L</sv_catpvf>> but copy the text into the SV instead of
+appending it.
-=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.
+The differences between these are:
+
+C<sv_setpvf> and C<sv_setpvf_nocontext> do not handle 'set' magic;
+C<sv_setpvf_mg> and C<sv_setpvf_mg_nocontext> do.
+
+C<sv_setpvf_nocontext> and C<sv_setpvf_mg_nocontext> do not take a thread
+context (C<aTHX>) parameter, so are used in situations where the caller
+doesn't already have the thread context.
=cut
*/
@@ -10799,19 +10806,6 @@ Perl_sv_vsetpvf(pTHX_ SV *const sv, const char *const pat, va_list *const args)
sv_vsetpvfn(sv, pat, strlen(pat), args, NULL, 0, NULL);
}
-/*
-=for apidoc sv_setpvf_mg
-
-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
-*/
-
void
Perl_sv_setpvf_mg(pTHX_ SV *const sv, const char *const pat, ...)
{