This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Integrate mainline
authorNick Ing-Simmons <nik@tiuk.ti.com>
Mon, 9 Jul 2001 16:33:50 +0000 (16:33 +0000)
committerNick Ing-Simmons <nik@tiuk.ti.com>
Mon, 9 Jul 2001 16:33:50 +0000 (16:33 +0000)
p4raw-id: //depot/perlio@11240

1  2 
pod/perlapi.pod

diff --cc pod/perlapi.pod
@@@ -1344,6 -1344,6 +1344,17 @@@ SV is B<not> incremented
  =for hackers
  Found in file sv.c
  
++=item newSV
++
++Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
++with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
++macro.
++
++      SV*     newSV(STRLEN len)
++
++=for hackers
++Found in file sv.c
++
  =item NEWSV
  
  Creates a new SV.  A non-zero C<len> parameter indicates the number of
@@@ -1357,17 -1357,17 +1368,6 @@@ C<id> is an integer id between 0 and 12
  =for hackers
  Found in file handy.h
  
--=item newSV
--
--Create a new null SV, or if len > 0, create a new empty SVt_PV type SV
--with an initial PV allocation of len+1. Normally accessed via the C<NEWSV>
--macro.
--
--      SV*     newSV(STRLEN len)
--
--=for hackers
--Found in file sv.c
--
  =item newSViv
  
  Creates a new SV and copies an integer into it.  The reference count for the
@@@ -2119,22 -2119,22 +2119,22 @@@ version which guarantees to evaluate s
  =for hackers
  Found in file sv.h
  
--=item SvIVx
++=item SvIVX
  
--Coerces the given SV to an integer and returns it. Guarantees to evaluate
--sv only once. Use the more efficent C<SvIV> otherwise.
++Returns the raw value in the SV's IV slot, without checks or conversions.
++Only use when you are sure SvIOK is true. See also C<SvIV()>.
  
--      IV      SvIVx(SV* sv)
++      IV      SvIVX(SV* sv)
  
  =for hackers
  Found in file sv.h
  
--=item SvIVX
++=item SvIVx
  
--Returns the raw value in the SV's IV slot, without checks or conversions.
--Only use when you are sure SvIOK is true. See also C<SvIV()>.
++Coerces the given SV to an integer and returns it. Guarantees to evaluate
++sv only once. Use the more efficent C<SvIV> otherwise.
  
--      IV      SvIVX(SV* sv)
++      IV      SvIVx(SV* sv)
  
  =for hackers
  Found in file sv.h
@@@ -2443,21 -2443,21 +2443,21 @@@ Like C<SvPV_nolen>, but converts sv to 
  =for hackers
  Found in file sv.h
  
--=item SvPVx
++=item SvPVX
  
--A version of C<SvPV> which guarantees to evaluate sv only once.
++Returns a pointer to the physical string in the SV.  The SV must contain a
++string.
  
--      char*   SvPVx(SV* sv, STRLEN len)
++      char*   SvPVX(SV* sv)
  
  =for hackers
  Found in file sv.h
  
--=item SvPVX
++=item SvPVx
  
--Returns a pointer to the physical string in the SV.  The SV must contain a
--string.
++A version of C<SvPV> which guarantees to evaluate sv only once.
  
--      char*   SvPVX(SV* sv)
++      char*   SvPVx(SV* sv, STRLEN len)
  
  =for hackers
  Found in file sv.h
@@@ -2664,19 -2664,19 +2664,19 @@@ false, defined or undefined.  Does not 
  =for hackers
  Found in file sv.h
  
--=item SvTYPE
--
--Returns the type of the SV.  See C<svtype>.
++=item svtype
  
--      svtype  SvTYPE(SV* sv)
++An enum of flags for Perl types.  These are found in the file B<sv.h> 
++in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
  
  =for hackers
  Found in file sv.h
  
--=item svtype
++=item SvTYPE
  
--An enum of flags for Perl types.  These are found in the file B<sv.h> 
--in the C<svtype> enum.  Test these flags with the C<SvTYPE> macro.
++Returns the type of the SV.  See C<svtype>.
++
++      svtype  SvTYPE(SV* sv)
  
  =for hackers
  Found in file sv.h