[prev in list] [next in list] [prev in thread] [next in thread]
List: perl5-changes
Subject: Change 34683: Integrate:
From: Nicholas Clark <nwc10+p5p4 () colon ! colondot ! net>
Date: 2008-10-31 11:30:02
Message-ID: 20081031113002.9860114002 () mx ! activestate ! com
[Download RAW message or body]
Change 34683 by nicholas@nicholas-plum on 2008/10/31 11:19:41
Integrate:
[ 34659]
Integrate:
[ 34566]
Subject: [PATCH blead DOC] Re: [perl #60022] Typo in perldata
From: Daniel Frederick Crisman <daniel@crisman.org>
Date: Thu, 23 Oct 2008 20:14:56 -0400
Message-ID: <20081024001456.GA4137@fury.crisman.org>
Change from cardinal to ordinal numbering to avoid confusion.
[ 34642]
Remove redundant API definitions from '=for apidoc' sections.
Those are already in embed.fnc, and most of them were already
outdated. This also fixes the docs for pv_escape and pv_pretty.
[ 34664]
Integrate:
[ 34649]
Remove redundant (and wrong) prototype for pv_display()
from its apidoc section.
Affected files ...
... //depot/maint-5.8/perl/dump.c#90 integrate
... //depot/maint-5.8/perl/pod/perlapi.pod#120 integrate
... //depot/maint-5.8/perl/pod/perldata.pod#23 integrate
... //depot/maint-5.8/perl/utf8.c#86 integrate
Differences ...
==== //depot/maint-5.8/perl/dump.c#90 (text) ====
Index: perl/dump.c
--- perl/dump.c#89~34633~ 2008-10-29 01:22:26.000000000 -0700
+++ perl/dump.c 2008-10-31 04:19:41.000000000 -0700
@@ -155,9 +155,7 @@
/*
-=for apidoc Apd|char*|pv_escape|NN SV *dsv|NN const char const *str\
- |const STRLEN count|const STRLEN max
- |STRLEN const *escaped, const U32 flags
+=for apidoc pv_escape
Escapes at most the first "count" chars of pv and puts the results into
dsv such that the size of the escaped string will not exceed "max" chars
@@ -271,10 +269,7 @@
return SvPVX(dsv);
}
/*
-=for apidoc Apd|char *|pv_pretty|NN SV *dsv|NN const char const *str\
- |const STRLEN count|const STRLEN max\
- |const char const *start_color| const char const *end_color\
- |const U32 flags
+=for apidoc pv_pretty
Converts a string into something presentable, handling escaping via
pv_escape() and supporting quoting and elipses.
@@ -335,9 +330,6 @@
/*
=for apidoc pv_display
- char *pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len,
- STRLEN pvlim, U32 flags)
-
Similar to
pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);
==== //depot/maint-5.8/perl/pod/perlapi.pod#120 (text+w) ====
Index: perl/pod/perlapi.pod
--- perl/pod/perlapi.pod#119~33866~ 2008-05-19 07:57:58.000000000 -0700
+++ perl/pod/perlapi.pod 2008-10-31 04:19:41.000000000 -0700
@@ -824,9 +824,6 @@
=item pv_escape
X<pv_escape>
- |const STRLEN count|const STRLEN max
- |STRLEN const *escaped, const U32 flags
-
Escapes at most the first "count" chars of pv and puts the results into
dsv such that the size of the escaped string will not exceed "max" chars
and will not contain any incomplete escape sequences.
@@ -857,8 +854,6 @@
Returns a pointer to the escaped text as held by dsv.
-NOTE: the perl_ form of this function is deprecated.
-
char* pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN \
max, STRLEN * const escaped, const U32 flags)
=for hackers
@@ -867,10 +862,6 @@
=item pv_pretty
X<pv_pretty>
- |const STRLEN count|const STRLEN max\
- |const char const *start_color| const char const *end_color\
- |const U32 flags
-
Converts a string into something presentable, handling escaping via
pv_escape() and supporting quoting and elipses.
@@ -890,8 +881,6 @@
Returns a pointer to the prettified text as held by dsv.
-NOTE: the perl_ form of this function is deprecated.
-
char* pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN \
max, char const * const start_color, char const * const end_color, const U32 flags)
=for hackers
==== //depot/maint-5.8/perl/pod/perldata.pod#23 (text) ====
Index: perl/pod/perldata.pod
--- perl/pod/perldata.pod#22~33805~ 2008-05-10 08:40:07.000000000 -0700
+++ perl/pod/perldata.pod 2008-10-31 04:19:41.000000000 -0700
@@ -672,7 +672,7 @@
square brackets. For example:
@myarray = (5, 50, 500, 5000);
- print "Element Number 2 is", $myarray[2], "\n";
+ print "The Third Element is", $myarray[2], "\n";
The array indices start with 0. A negative subscript retrieves its
value from the end. In our example, C<$myarray[-1]> would have been
==== //depot/maint-5.8/perl/utf8.c#86 (text) ====
Index: perl/utf8.c
--- perl/utf8.c#85~34633~ 2008-10-29 01:22:26.000000000 -0700
+++ perl/utf8.c 2008-10-31 04:19:41.000000000 -0700
@@ -44,7 +44,7 @@
characters in the ASCII range are unmodified, and a zero byte never appears
within non-zero characters.
-=for apidoc A|U8 *|uvuni_to_utf8_flags|U8 *d|UV uv|UV flags
+=for apidoc uvuni_to_utf8_flags
Adds the UTF-8 representation of the Unicode codepoint C<uv> to the end
of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
@@ -233,7 +233,7 @@
}
/*
-=for apidoc A|STRLEN|is_utf8_char|U8 *s
+=for apidoc is_utf8_char
Tests if some arbitrary number of bytes begins in a valid UTF-8
character. Note that an INVARIANT (i.e. ASCII) character is a valid
@@ -254,7 +254,7 @@
}
/*
-=for apidoc A|bool|is_utf8_string|U8 *s|STRLEN len
+=for apidoc is_utf8_string
Returns true if first C<len> bytes of the given string form a valid
UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does
@@ -310,7 +310,7 @@
/*
Implemented as a macro in utf8.h
-=for apidoc A|bool|is_utf8_string_loc|const U8 *s|STRLEN len|const U8 **ep
+=for apidoc is_utf8_string_loc
Like is_utf8_string() but stores the location of the failure (in the
case of "utf8ness failure") or the location s+len (in the case of
@@ -318,7 +318,7 @@
See also is_utf8_string_loclen() and is_utf8_string().
-=for apidoc A|bool|is_utf8_string_loclen|const U8 *s|STRLEN len|const U8 **ep|const \
STRLEN *el +=for apidoc is_utf8_string_loclen
Like is_utf8_string() but stores the location of the failure (in the
case of "utf8ness failure") or the location s+len (in the case of
@@ -375,7 +375,7 @@
/*
-=for apidoc A|UV|utf8n_to_uvuni|U8 *s|STRLEN curlen|STRLEN *retlen|U32 flags
+=for apidoc utf8n_to_uvuni
Bottom level UTF-8 decode routine.
Returns the Unicode code point value of the first character in the string C<s>
@@ -601,7 +601,7 @@
}
/*
-=for apidoc A|UV|utf8_to_uvchr|U8 *s|STRLEN *retlen
+=for apidoc utf8_to_uvchr
Returns the native character value of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
@@ -621,7 +621,7 @@
}
/*
-=for apidoc A|UV|utf8_to_uvuni|U8 *s|STRLEN *retlen
+=for apidoc utf8_to_uvuni
Returns the Unicode code point of the first character in the string C<s>
which is assumed to be in UTF-8 encoding; C<retlen> will be set to the
@@ -645,7 +645,7 @@
}
/*
-=for apidoc A|STRLEN|utf8_length|U8 *s|U8 *e
+=for apidoc utf8_length
Return the length of the UTF-8 char encoded string C<s> in characters.
Stops at C<e> (inclusive). If C<e E<lt> s> or if the scan would end
@@ -687,7 +687,7 @@
}
/*
-=for apidoc A|IV|utf8_distance|U8 *a|U8 *b
+=for apidoc utf8_distance
Returns the number of UTF-8 characters between the UTF-8 pointers C<a>
and C<b>.
@@ -705,7 +705,7 @@
}
/*
-=for apidoc A|U8 *|utf8_hop|U8 *s|I32 off
+=for apidoc utf8_hop
Return the UTF-8 pointer C<s> displaced by C<off> characters, either
forward or backward.
@@ -740,7 +740,7 @@
}
/*
-=for apidoc A|U8 *|utf8_to_bytes|U8 *s|STRLEN *len
+=for apidoc utf8_to_bytes
Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
Unlike C<bytes_to_utf8>, this over-writes the original string, and
@@ -783,7 +783,7 @@
}
/*
-=for apidoc A|U8 *|bytes_from_utf8|const U8 *s|STRLEN *len|bool *is_utf8
+=for apidoc bytes_from_utf8
Converts a string C<s> of length C<len> from UTF-8 into byte encoding.
Unlike C<utf8_to_bytes> but like C<bytes_to_utf8>, returns a pointer to
@@ -839,7 +839,7 @@
}
/*
-=for apidoc A|U8 *|bytes_to_utf8|U8 *s|STRLEN *len
+=for apidoc bytes_to_utf8
Converts a string C<s> of length C<len> from ASCII into UTF-8 encoding.
Returns a pointer to the newly-created string, and sets C<len> to
@@ -1330,7 +1330,7 @@
}
/*
-=for apidoc A|UV|to_utf8_case|U8 *p|U8* ustrp|STRLEN *lenp|SV **swash|char \
*normal|char *special +=for apidoc to_utf8_case
The "p" contains the pointer to the UTF-8 string encoding
the character that is being converted.
@@ -1441,7 +1441,7 @@
}
/*
-=for apidoc A|UV|to_utf8_upper|U8 *p|U8 *ustrp|STRLEN *lenp
+=for apidoc to_utf8_upper
Convert the UTF-8 encoded character at p to its uppercase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
@@ -1461,7 +1461,7 @@
}
/*
-=for apidoc A|UV|to_utf8_title|U8 *p|U8 *ustrp|STRLEN *lenp
+=for apidoc to_utf8_title
Convert the UTF-8 encoded character at p to its titlecase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
@@ -1481,7 +1481,7 @@
}
/*
-=for apidoc A|UV|to_utf8_lower|U8 *p|U8 *ustrp|STRLEN *lenp
+=for apidoc to_utf8_lower
Convert the UTF-8 encoded character at p to its lowercase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
@@ -1501,7 +1501,7 @@
}
/*
-=for apidoc A|UV|to_utf8_fold|U8 *p|U8 *ustrp|STRLEN *lenp
+=for apidoc to_utf8_fold
Convert the UTF-8 encoded character at p to its foldcase version and
store that in UTF-8 in ustrp and its length in bytes in lenp. Note
@@ -2041,7 +2041,7 @@
}
/*
-=for apidoc A|U8 *|uvchr_to_utf8|U8 *d|UV uv
+=for apidoc uvchr_to_utf8
Adds the UTF-8 representation of the Native codepoint C<uv> to the end
of the string C<d>; C<d> should be have at least C<UTF8_MAXBYTES+1> free
@@ -2073,7 +2073,7 @@
}
/*
-=for apidoc A|UV|utf8n_to_uvchr|U8 *s|STRLEN curlen|STRLEN *retlen|U32
+=for apidoc utf8n_to_uvchr
flags
Returns the native character value of the first character in the string
@@ -2096,7 +2096,7 @@
}
/*
-=for apidoc A|char *|pv_uni_display|SV *dsv|U8 *spv|STRLEN len|STRLEN pvlim|UV flags
+=for apidoc pv_uni_display
Build to the scalar dsv a displayable version of the string spv,
length len, the displayable version being at most pvlim bytes long
@@ -2172,7 +2172,7 @@
}
/*
-=for apidoc A|char *|sv_uni_display|SV *dsv|SV *ssv|STRLEN pvlim|UV flags
+=for apidoc sv_uni_display
Build to the scalar dsv a displayable version of the scalar sv,
the displayable version being at most pvlim bytes long
@@ -2192,7 +2192,7 @@
}
/*
-=for apidoc A|I32|ibcmp_utf8|const char *s1|char **pe1|register UV l1|bool u1|const \
char *s2|char **pe2|register UV l2|bool u2 +=for apidoc ibcmp_utf8
Return true if the strings s1 and s2 differ case-insensitively, false
if not (if they are equal case-insensitively). If u1 is true, the
End of Patch.
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic