From: Nick Ing-Simmons <nik@tiuk.ti.com>
Date: Tue, 19 Mar 2002 07:39:07 +0000 (+0000)
Subject: Move docs for Encode::valid_utf8 (which does not exist)
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=5463e635e29aad1605d20ed3ea9f8b3e487e0102;p=p5sagit%2Fp5-mst-13.2.git

Move docs for Encode::valid_utf8 (which does not exist)
to be docs for utf8::valid() (which does).

p4raw-id: //depot/perlio@15314
---

diff --git a/ext/Encode/Encode.pm b/ext/Encode/Encode.pm
index a0cc7e2..6a86673 100644
--- a/ext/Encode/Encode.pm
+++ b/ext/Encode/Encode.pm
@@ -57,7 +57,7 @@ our %winlatin2cp   = (
 		      'Vietnamese' => 1258,
 		     );
 
-our %external_tables = 
+our %external_tables =
     (
 	'euc-cn'	=> 'Encode/CN.pm',
 	gb2312		=> 'Encode/CN.pm',
@@ -898,14 +898,6 @@ implementation.  As such they are efficient, but may change.
 If CHECK is true, also checks the data in STRING for being well-formed
 UTF-8.  Returns true if successful, false otherwise.
 
-=item * valid_utf8(STRING)
-
-[INTERNAL] Test whether STRING is in a consistent state.  Will return
-true if string is held as bytes, or is well-formed UTF-8 and has the
-UTF-8 flag on.  Main reason for this routine is to allow Perl's
-testsuite to check that operations have left strings in a consistent
-state.
-
 =item *
 
         _utf8_on(STRING)
@@ -1091,7 +1083,9 @@ to be rationalized.
 
 =head1 SEE ALSO
 
-L<perlunicode>, L<perlebcdic>, L<perlfunc/open>, L<PerlIO>, L<encoding>
+L<perlunicode>, L<perlebcdic>, L<perlfunc/open>, L<PerlIO>, L<encoding>,
+L<utf8>
+
 
 =cut
 
diff --git a/lib/utf8.pm b/lib/utf8.pm
index 9023eb6..5bec955 100644
--- a/lib/utf8.pm
+++ b/lib/utf8.pm
@@ -35,7 +35,7 @@ utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code
 
 The C<use utf8> pragma tells the Perl parser to allow UTF-8 in the
 program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based
-platforms).  The C<no utf8> pragma tells Perl to switch back to treating 
+platforms).  The C<no utf8> pragma tells Perl to switch back to treating
 the source text as literal bytes in the current lexical scope.
 
 This pragma is primarily a compatibility device.  Perl versions
@@ -103,6 +103,14 @@ Attempts to convert I<$string> in-place from Perl's I<UTF-X> encoding
 into logical characters.  Note that this should not be used to convert
 Unicode back to a legacy byte encoding: use Encode for that.
 
+=item * $flag = utf8::valid(STRING)
+
+[INTERNAL] Test whether STRING is in a consistent state.  Will return
+true if string is held as bytes, or is well-formed UTF-8 and has the
+UTF-8 flag on.  Main reason for this routine is to allow Perl's
+testsuite to check that operations have left strings in a consistent
+state.
+
 =back
 
 C<utf8::encode> is like C<utf8::upgrade>, but the UTF8 flag is cleared.