summaryrefslogtreecommitdiff
path: root/sv.c
diff options
context:
space:
mode:
authorChip Salzenberg <chip@pobox.com>2011-10-10 19:03:18 -0700
committerChip Salzenberg <chip@pobox.com>2011-10-10 19:03:18 -0700
commitb07bf0000e330d07814bab45d5579f1b46a6cdfd (patch)
tree1bc13d784185a1266efeca1b311ea7a1060decca /sv.c
parentbbddc9e0e65fab109b17ff2bc97d20cd4a2d6929 (diff)
downloadperl-b07bf0000e330d07814bab45d5579f1b46a6cdfd.tar.gz
tweak sv_chop pod
Diffstat (limited to 'sv.c')
-rw-r--r--sv.c5
1 files changed, 5 insertions, 0 deletions
diff --git a/sv.c b/sv.c
index 275118f632..e20fec09dc 100644
--- a/sv.c
+++ b/sv.c
@@ -4885,9 +4885,14 @@ Efficient removal of characters from the beginning of the string buffer.
SvPOK(sv) must be true and the C<ptr> must be a pointer to somewhere inside
the string buffer. The C<ptr> becomes the first character of the adjusted
string. Uses the "OOK hack".
+
Beware: after this function returns, C<ptr> and SvPVX_const(sv) may no longer
refer to the same chunk of data.
+The unfortunate similarity of this function's name to that of Perl's C<chop>
+operator is strictly coincidental. This function works from the left;
+C<chop> works from the right.
+
=cut
*/