Skip to content

Commit 3849ad7

Browse files
committed
perlapi: Document sv_dup(_inc)?
1 parent d05a890 commit 3849ad7

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

sv.c

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14970,6 +14970,20 @@ S_sv_dup_common(pTHX_ const SV *const ssv, CLONE_PARAMS *const param)
1497014970
return dsv;
1497114971
}
1497214972

14973+
/*
14974+
=for apidoc sv_dup
14975+
=for apidoc_item sv_dup_inc
14976+
14977+
In spite of their generic names, these are very specialized functions mainly
14978+
for use when cloning an interpreter instance.
14979+
14980+
They duplicate an SV of any type (not just a plain SV, but including AV, HV
14981+
I<etc>.), returning a pointer to the cloned object. The difference is that the
14982+
new SV under C<sv_dup> has a reference count of 0, but 1 under C<sv_dup_inc>.
14983+
14984+
=cut
14985+
*/
14986+
1497314987
SV *
1497414988
Perl_sv_dup_inc(pTHX_ const SV *const ssv, CLONE_PARAMS *const param)
1497514989
{

0 commit comments

Comments
 (0)