Change pods to not refer to av_len()
authorKarl Williamson <public@khwilliamson.com>
Sat, 2 Feb 2013 17:18:45 +0000 (10:18 -0700)
committerKarl Williamson <public@khwilliamson.com>
Fri, 8 Feb 2013 21:44:24 +0000 (14:44 -0700)
This name for the function is misleading; don't encourage its use.

dist/ExtUtils-ParseXS/lib/perlxstut.pod
pod/perlembed.pod
pp_sort.c

index 0afa408..d36f425 100644 (file)
@@ -1095,7 +1095,7 @@ Mytest.xs:
            SvGETMAGIC(paths);
            if ((!SvROK(paths))
                || (SvTYPE(SvRV(paths)) != SVt_PVAV)
-               || ((numpaths = av_len((AV *)SvRV(paths))) < 0))
+               || ((numpaths = av_top_index((AV *)SvRV(paths))) < 0))
            {
                XSRETURN_UNDEF;
            }
@@ -1158,7 +1158,7 @@ true, which indicates that paths is a valid reference.  (Simply
 checking C<SvROK> won't trigger FETCH on a tied variable.)  It
 then verifies that the object referenced by paths is an array, using C<SvRV>
 to dereference paths, and C<SvTYPE> to discover its type.  As an added test,
-it checks that the array referenced by paths is non-empty, using the C<av_len>
+it checks that the array referenced by paths is non-empty, using the C<av_top_index>
 function (which returns -1 if the array is empty).  The XSRETURN_UNDEF macro
 is used to abort the XSUB and return the undefined value whenever all three of
 these conditions are not met.
@@ -1167,7 +1167,7 @@ these conditions are not met.
 
 We manipulate several arrays in this XSUB.  Note that an array is represented
 internally by an AV* pointer.  The functions and macros for manipulating
-arrays are similar to the functions in Perl: C<av_len> returns the highest
+arrays are similar to the functions in Perl: C<av_top_index> returns the highest
 index in an AV*, much like $#array; C<av_fetch> fetches a single scalar value
 from an array, given its index; C<av_push> pushes a scalar value onto the
 end of the array, automatically extending the array as necessary.
index e40035e..1596df8 100644 (file)
@@ -490,7 +490,7 @@ been wrapped here):
      SvREFCNT_dec(command);
 
      *match_list = get_av("array", 0);
-     num_matches = av_len(*match_list) + 1;
+     num_matches = av_top_index(*match_list) + 1;
 
      return num_matches;
  }
index d6a5e88..bf7182b 100644 (file)
--- a/pp_sort.c
+++ b/pp_sort.c
@@ -1432,7 +1432,7 @@ S_qsortsv(pTHX_ gptr *list1, size_t nmemb, SVCOMPARE_t cmp, U32 flags)
 
 Sort an array. Here is an example:
 
-    sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);
+    sortsv(AvARRAY(av), av_top_index(av)+1, Perl_sv_cmp_locale);
 
 Currently this always uses mergesort. See sortsv_flags for a more
 flexible routine.