summaryrefslogtreecommitdiff
path: root/pod
diff options
context:
space:
mode:
authorGurusamy Sarathy <gsar@cpan.org>2000-07-11 18:21:19 +0000
committerGurusamy Sarathy <gsar@cpan.org>2000-07-11 18:21:19 +0000
commit6662521eef19f96de52b97fb5fa07a85826679ee (patch)
tree3445a5d5bc8939118a426b52b520e63e7fe5035c /pod
parent7fdcfa2fc732bf742f6e1c2b723ab188bf8dc010 (diff)
downloadperl-6662521eef19f96de52b97fb5fa07a85826679ee.tar.gz
integrate cfgperl changes#6242..6249 into mainline
p4raw-link: @6249 on //depot/cfgperl: cab27d238e930b8cddb5b1fb3260355f913b86a6 p4raw-link: @6242 on //depot/cfgperl: 1e72252ad7b8e23d1a1142285b8aa82986bd2491 p4raw-id: //depot/perl@6359 p4raw-integrated: from //depot/cfgperl@6358 'copy in' ext/DynaLoader/DynaLoader_pm.PL (@5953..) t/lib/peek.t (@6086..) t/lib/filefunc.t t/lib/filespec.t (@6230..) pod/perlintern.pod (@6237..) pod/perlapi.pod utf8.c (@6242..) p4raw-integrated: from //depot/cfgperl@6249 'copy in' lib/IPC/Open3.pm (@5937..) p4raw-integrated: from //depot/cfgperl@6248 'copy in' pod/perlfunc.pod (@6206..) p4raw-integrated: from //depot/cfgperl@6247 'ignore' lib/File/Spec.pm (@6230..) p4raw-integrated: from //depot/cfgperl@6244 'copy in' gv.c (@6217..) 'merge in' sv.c (@6196..) p4raw-integrated: from //depot/cfgperl@6243 'copy in' pp_proto.h (@6237..) 'ignore' embedvar.h perlapi.h (@6237..) 'merge in' embed.h objXSUB.h (@6237..) embed.pl perlapi.c proto.h (@6242..)
Diffstat (limited to 'pod')
-rw-r--r--pod/perlapi.pod30
-rw-r--r--pod/perlfunc.pod15
2 files changed, 33 insertions, 12 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index f274641029..86ad5bd1bb 100644
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -153,9 +153,10 @@ Found in file av.c
=item bytes_to_utf8
Converts a string C<s> of length C<len> from ASCII into UTF8 encoding.
-Returns a pointer to the newly-created string.
+Returns a pointer to the newly-created string, and sets C<len> to
+reflect the new length.
- U8 * bytes_to_utf8(U8 *s, STRLEN len)
+ U8 * bytes_to_utf8(U8 *s, STRLEN *len)
=for hackers
Found in file utf8.c
@@ -2281,19 +2282,19 @@ false, defined or undefined. Does not handle 'get' magic.
=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
-=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
@@ -2938,10 +2939,21 @@ Converts the specified character to uppercase.
=for hackers
Found in file handy.h
+=item U8 *s
+
+Returns true if first C<len> bytes of the given string form valid a UTF8
+string, false otherwise.
+
+ bool_utf8_string U8 *s(STRLEN len)
+
+=for hackers
+Found in file utf8.c
+
=item utf8_to_bytes
Converts a string C<s> of length C<len> from UTF8 into ASCII encoding.
Unlike C<bytes_to_utf8>, this over-writes the original string.
+Returns zero on failure after converting as much as possible.
U8 * utf8_to_bytes(U8 *s, STRLEN len)
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index ce08134532..6b4e971f97 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -4379,9 +4379,18 @@ L</chomp>, and L</join>.)
=item sprintf FORMAT, LIST
-Returns a string formatted by the usual C<printf> conventions of the
-C library function C<sprintf>. See L<sprintf(3)> or L<printf(3)>
-on your system for an explanation of the general principles.
+Returns a string formatted by the usual C<printf> conventions of the C
+library function C<sprintf>. See below for more details
+and see L<sprintf(3)> or L<printf(3)> on your system for an explanation of
+the general principles.
+
+For example:
+
+ # Format number with up to 8 leading zeroes
+ $result = sprintf("%08d", $number);
+
+ # Round number to 3 digits after decimal point
+ $rounded = sprintf("%.3f", $number);
Perl does its own C<sprintf> formatting--it emulates the C
function C<sprintf>, but it doesn't use it (except for floating-point