[perl #91790] Perlguts documentation for sv_setref_pv

# New Ticket Created by  "Ben Bullock" 
# Please include the string:  [perl #91790]
# in the subject line of all future correspondence about this issue. 
# <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=91790 >


This is a bug report for perl from benkasminbullock@gmail.com,
generated with the help of perlbug 1.39 running under perl 5.12.3.


-----------------------------------------------------------------
[Please describe your issue here]

The following documentation as found on search.cpan.org is wrong:

http://search.cpan.org/~jesse/perl-5.14.0/pod/perlguts.pod

SV* sv_setref_pv(SV* rv, const char* classname, PV iv);
Copies string into an SV whose reference is rv. Set length to 0 to let
Perl calculate the string length. SV is blessed if classname is
non-null.

This bit about "Set length to 0" does not relate to anything in this
function, which doesn't even have a "length" anywhere. Or if it does
have a "length" which isn't mentioned, that is the bug.


[Please do not change anything below this line]
-----------------------------------------------------------------
---
Flags:
    category=docs
    severity=low
---
Site configuration information for perl 5.12.3:

Configured by ben at Thu May 12 11:03:12 JST 2011.

Summary of my perl5 (revision 5 version 12 subversion 3) configuration:

  Platform:
    osname=freebsd, osvers=7.3-release, archname=i386-freebsd
    uname='freebsd mikan 7.3-release freebsd 7.3-release #0: sun mar
21 06:15:01 utc 2010
root@walker.cse.buffalo.edu:usrobjusrsrcsysgeneric i386 '
    config_args=''
    hint=recommended, useposix=true, d_sigaction=define
    useithreads=undef, usemultiplicity=undef
    useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef
    use64bitint=undef, use64bitall=undef, uselongdouble=undef
    usemymalloc=n, bincompat5005=undef
  Compiler:
    cc='cc', ccflags ='-DHAS_FPSETMASK -DHAS_FLOATINGPOINT_H
-DDEBUGGING -fno-strict-aliasing -pipe -fstack-protector
-I/usr/local/include',
    optimize='-g',
    cppflags='-DHAS_FPSETMASK -DHAS_FLOATINGPOINT_H -DDEBUGGING
-fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include'
    ccversion='', gccversion='4.2.1 20070719  [FreeBSD]', gccosandvers=''
    intsize=4, longsize=4, ptrsize=4, doublesize=8, byteorder=1234
    d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=12
    ivtype='long', ivsize=4, nvtype='double', nvsize=8, Off_t='off_t',
lseeksize=8
    alignbytes=4, prototype=define
  Linker and Libraries:
    ld='cc', ldflags ='-Wl,-E  -fstack-protector -L/usr/local/lib'
    libpth=/usr/lib /usr/local/lib
    libs=-lgdbm -lm -lcrypt -lutil -lc
    perllibs=-lm -lcrypt -lutil -lc
    libc=, so=so, useshrplib=false, libperl=libperl.a
    gnulibc_version=''
  Dynamic Linking:
    dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags=' '
    cccdlflags='-DPIC -fPIC', lddlflags='-shared  -L/usr/local/lib
-fstack-protector'

Locally applied patches:


---
@INC for perl 5.12.3:
    /home/ben/software/install/lib/perl5/site_perl/5.12.3/i386-freebsd
    /home/ben/software/install/lib/perl5/site_perl/5.12.3
    /home/ben/software/install/lib/perl5/5.12.3/i386-freebsd
    /home/ben/software/install/lib/perl5/5.12.3
    /home/ben/software/install/lib/perl5/site_perl/5.10.0
    /home/ben/software/install/lib/perl5/site_perl
    .

---
Environment for perl 5.12.3:
    HOME=/home/ben
    LANG (unset)
    LANGUAGE (unset)
    LD_LIBRARY_PATH (unset)
    LOGDIR (unset)
    PATH=/home/ben/bin:/home/ben/software/install/bin:/home/ben/bin:/home/ben/software/install/bin:/sbin:/bin:/usr/sbin:/usr/bin:/usr/games:/usr/local/sbin:/usr/local/bin:/home/ben/bin
    PERL_BADLANG (unset)
    SHELL=/usr/local/bin/bash

• [perl #91790] Perlguts documentation for sv_setref_pv by Ben Bullock
• Re: [perl #91790] Perlguts documentation for sv_setref_pv by Dave Mitchell