From 41596d6312f801eecb38c50e3f6f713bc66c1ca2 Mon Sep 17 00:00:00 2001 From: Daniel Dragan Date: Thu, 15 Jan 2015 22:30:25 -0500 Subject: improve SvPV_set's docs, it really shouldn't be public API Someone else in the perl community wrote XS code using SvPV_set instead of sv_setpvn and couldn't figure out why he was getting heap corruption/failed asserts/SEGVs/etc. Improve the docs to basically say never use this. (cherry picked from commit f2979eac0a03fcba1cd431ef3d46f697176ebcc8) Bug-Debian: https://bugs.debian.org/822336 Patch-Name: fixes/5.20.3/docs/SvPV_set.diff --- sv.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/sv.h b/sv.h index b129225bd3..15163e439c 100644 --- a/sv.h +++ b/sv.h @@ -792,13 +792,18 @@ C instead of the lvalue assignment to C. Set the value of the NV pointer in sv to val. See C. =for apidoc Am|void|SvPV_set|SV* sv|char* val -Set the value of the PV pointer in C to the C-terminated string -C. See also C. +This is probably not what you want to use, you probably wanted +L or L or L. +Set the value of the PV pointer in C to the Perl allocated +C-terminated string C. See also C. + +Remember to free the previous PV buffer. There are many things to check. Beware that the existing pointer may be involved in copy-on-write or other mischief, so do C and use C or C (or check the SvIsCOW flag) first to make sure this -modification is safe. +modification is safe. Then finally, if it is not a COW, call C to +free the previous PV buffer. =for apidoc Am|void|SvUV_set|SV* sv|UV val Set the value of the UV pointer in sv to val. See C.