This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Change the synopsis in POSIX.pod to stress use POSIX ();
authorNicholas Clark <nick@ccl4.org>
Thu, 1 Sep 2011 19:51:41 +0000 (21:51 +0200)
committerNicholas Clark <nick@ccl4.org>
Thu, 1 Sep 2011 19:54:14 +0000 (21:54 +0200)
Explicitly warn that the default of importing everything means that
use POSIX; has to import 553 symbols. Hence it's probably better to use
an explicit import list, or import nothing.

ext/POSIX/lib/POSIX.pod

index c2ca1c9..f935ae0 100644 (file)
@@ -4,7 +4,7 @@ POSIX - Perl interface to IEEE Std 1003.1
 
 =head1 SYNOPSIS
 
-    use POSIX;
+    use POSIX ();
     use POSIX qw(setsid);
     use POSIX qw(:errno_h :fcntl_h);
 
@@ -26,7 +26,9 @@ functions with the same name as a built-in Perl function, such as
 C<abs>, C<alarm>, C<rmdir>, C<write>, etc.., which will be exported
 only if you ask for them explicitly.  This is an unfortunate backwards
 compatibility feature.  You can stop the exporting by saying C<use
-POSIX ()> and then use the fully qualified names (ie. C<POSIX::SEEK_END>).
+POSIX ()> and then use the fully qualified names (ie. C<POSIX::SEEK_END>),
+or by giving an explicit import list.  If you do neither, and opt for the
+default, C<use POSIX;> has to import I<553 symbols>.
 
 This document gives a condensed list of the features available in the POSIX
 module.  Consult your operating system's manpages for general information on