[inseparable changes from patch from perl5.003_22 to perl5.003_23]
[p5sagit/p5-mst-13.2.git] / pod / perldelta.pod
CommitLineData
5f05dabc 1=head1 NAME
2
774d564b 3perldelta - what's new for perl5.004
5f05dabc 4
5=head1 DESCRIPTION
6
7This document describes differences between the 5.003 release (as
8documented in I<Programming Perl>, second edition--the Camel Book) and
9this one.
10
11=head1 Supported Environments
12
13Perl5.004 builds out of the box on Unix, Plan9, LynxOS, VMS, OS/2,
14QNX, and AmigaOS.
15
16=head1 Core Changes
17
18Most importantly, many bugs were fixed. See the F<Changes>
19file in the distribution for details.
20
21=head2 Compilation Option: Binary Compatibility With 5.003
22
23There is a new Configure question that asks if you want to maintain
24binary compatibility with Perl 5.003. If you choose binary
25compatibility, you do not have to recompile your extensions, but you
44a8e56a 26might have symbol conflicts if you embed Perl in another application,
774d564b 27just as in the 5.003 release. By default, binary compatibility
28is preserved at the expense of symbol table pollution.
5f05dabc 29
7cfe7857 30=head2 New Opcode Module and Revised Safe Module
31
32A new Opcode module supports the creation, manipulation and
33application of opcode masks. The revised Safe module has a new API
34and is implemented using the new Opcode module. Please read the new
35Opcode and Safe documentation.
36
774d564b 37=head2 Extended Fcntl Module
38
39The Fcntl module now supports these new constants
40
41 F_GETOWN F_SETOWN
42 O_ASYNC O_DEFER O_DSYNC O_RSYNC O_SYNC
43 O_EXLOCK O_SHLOCK
44
45provided that your operating system supports these constants. The
46constants are for use with the Perl sysopen() and fcntl(). These
47constants are also visible for the basic database modules like the
48SDBM_File. For the exact meaning of these contants and other Fcntl
49constants please refer to the fcntl() documentation of your operating
50system. Unsupported constants will cause run-time errors.
51
5f05dabc 52=head2 Internal Change: FileHandle Deprecated
53
54Filehandles are now stored internally as type IO::Handle.
55Although C<use FileHandle> and C<*STDOUT{FILEHANDLE}>
774d564b 56are still supported for backwards compatibility,
5f05dabc 57C<use IO::Handle> (or C<IO::Seekable> or C<IO::File>) and
58C<*STDOUT{IO}> are the way of the future.
59
28757baa 60=head2 Internal Change: PerlIO internal IO abstraction interface
5f05dabc 61
62It is now possible to build Perl with AT&T's sfio IO package
63instead of stdio. See L<perlapio> for more details, and
64the F<INSTALL> file for how to use it.
65
66=head2 New and Changed Built-in Variables
67
68=over
69
70=item $^E
71
72Extended error message under some platforms ($EXTENDED_OS_ERROR
73if you C<use English>).
74
75=item $^H
76
77The current set of syntax checks enabled by C<use strict>. See the
78documentation of C<strict> for more details. Not actually new, but
79newly documented.
80Because it is intended for internal use by Perl core components,
81there is no C<use English> long name for this variable.
82
83=item $^M
84
85By default, running out of memory it is not trappable. However, if
86compiled for this, Perl may use the contents of C<$^M> as an emergency
87pool after die()ing with this message. Suppose that your Perl were
88compiled with -DEMERGENCY_SBRK and used Perl's malloc. Then
89
90 $^M = 'a' x (1<<16);
91
774d564b 92would allocate a 64K buffer for use when in emergency.
5f05dabc 93See the F<INSTALL> file for information on how to enable this option.
94As a disincentive to casual use of this advanced feature,
95there is no C<use English> long name for this variable.
96
97=back
98
99=head2 New and Changed Built-in Functions
100
101=over
102
103=item delete on slices
104
105This now works. (e.g. C<delete @ENV{'PATH', 'MANPATH'}>)
106
107=item flock
108
109is now supported on more platforms, and prefers fcntl
110to lockf when emulating.
111
112=item keys as an lvalue
113
114As an lvalue, C<keys> allows you to increase the number of hash buckets
115allocated for the given associative array. This can gain you a measure
116of efficiency if you know the hash is going to get big. (This is
117similar to pre-extending an array by assigning a larger number to
118$#array.) If you say
119
120 keys %hash = 200;
121
122then C<%hash> will have at least 200 buckets allocated for it. These
123buckets will be retained even if you do C<%hash = ()>; use C<undef
124%hash> if you want to free the storage while C<%hash> is still in scope.
125You can't shrink the number of buckets allocated for the hash using
126C<keys> in this way (but you needn't worry about doing this by accident,
127as trying has no effect).
128
129=item my() in Control Structures
130
131You can now use my() (with or without the parentheses) in the control
132expressions of control structures such as:
133
134 while (my $line = <>) {
135 $line = lc $line;
136 } continue {
137 print $line;
138 }
139
774d564b 140 if ((my $answer = <STDIN>) =~ /^y(es)?$/i) {
5f05dabc 141 user_agrees();
774d564b 142 } elsif ($answer =~ /^n(o)?$/i) {
5f05dabc 143 user_disagrees();
144 } else {
145 chomp $answer;
774d564b 146 die "`$answer' is neither `yes' nor `no'";
5f05dabc 147 }
148
149Also, you can declare a foreach loop control variable as lexical by
150preceding it with the word "my". For example, in:
151
152 foreach my $i (1, 2, 3) {
153 some_function();
154 }
155
156$i is a lexical variable, and the scope of $i extends to the end of
157the loop, but not beyond it.
158
159Note that you still cannot use my() on global punctuation variables
160such as $_ and the like.
161
162=item unpack() and pack()
163
164A new format 'w' represents a BER compressed integer (as defined in
165ASN.1). Its format is a sequence of one or more bytes, each of which
166provides seven bits of the total value, with the most significant
167first. Bit eight of each byte is set, except for the last byte, in
168which bit eight is clear.
169
170=item use VERSION
171
172If the first argument to C<use> is a number, it is treated as a version
173number instead of a module name. If the version of the Perl interpreter
174is less than VERSION, then an error message is printed and Perl exits
774d564b 175immediately. Because C<use> occurs at compile time, this check happens
176immediately during the compilation process, unlike C<require VERSION>,
177which waits until run-time for the check. This is often useful if you
178need to check the current Perl version before C<use>ing library modules
179which have changed in incompatible ways from older versions of Perl.
180(We try not to do this more than we have to.)
5f05dabc 181
182=item use Module VERSION LIST
183
184If the VERSION argument is present between Module and LIST, then the
71be2cbc 185C<use> will call the VERSION method in class Module with the given
186version as an argument. The default VERSION method, inherited from
187the Universal class, croaks if the given version is larger than the
188value of the variable $Module::VERSION. (Note that there is not a
189comma after VERSION!)
5f05dabc 190
7cfe7857 191This version-checking mechanism is similar to the one currently used
192in the Exporter module, but it is faster and can be used with modules
193that don't use the Exporter. It is the recommended method for new
194code.
195
5f05dabc 196=item prototype(FUNCTION)
197
198Returns the prototype of a function as a string (or C<undef> if the
199function has no prototype). FUNCTION is a reference to or the name of the
200function whose prototype you want to retrieve.
201(Not actually new; just never documented before.)
202
203=item $_ as Default
204
205Functions documented in the Camel to default to $_ now in
206fact do, and all those that do are so documented in L<perlfunc>.
207
774d564b 208=item C<m//g> does not trigger a pos() reset on failure
44a8e56a 209
210The C<m//g> match iteration construct used to reset the iteration
211when it failed to match (so that the next C<m//g> match would start at
212the beginning of the string). You now have to explicitly do a
213C<pos $str = 0;> to reset the "last match" position, or modify the
214string in some way. This change makes it practical to chain C<m//g>
215matches together in conjunction with ordinary matches using the C<\G>
216zero-width assertion. See L<perlop> and L<perlre>.
217
774d564b 218=item nested C<sub{}> closures work now
219
220Prior to the 5.004 release, nested anonymous functions
221didn't work right. They do now.
222
223=item formats work right on changing lexicals
224
225Just like anonymous functions that contain lexical variables
226that change (like a lexical index variable for a C<foreach> loop),
227formats now work properly. For example, this silently failed
228before, and is fine now:
229
230 my $i;
231 foreach $i ( 1 .. 10 ) {
232 format =
233 my i is @#
234 $i
235 .
236 write;
237 }
238
5f05dabc 239=back
240
241=head2 New Built-in Methods
242
243The C<UNIVERSAL> package automatically contains the following methods that
244are inherited by all other classes:
245
246=over 4
247
248=item isa(CLASS)
249
250C<isa> returns I<true> if its object is blessed into a sub-class of C<CLASS>
251
252C<isa> is also exportable and can be called as a sub with two arguments. This
253allows the ability to check what a reference points to. Example:
254
255 use UNIVERSAL qw(isa);
256
257 if(isa($ref, 'ARRAY')) {
258 ...
259 }
260
261=item can(METHOD)
262
263C<can> checks to see if its object has a method called C<METHOD>,
264if it does then a reference to the sub is returned; if it does not then
265I<undef> is returned.
266
267=item VERSION( [NEED] )
268
71be2cbc 269C<VERSION> returns the version number of the class (package). If the
270NEED argument is given then it will check that the current version (as
271defined by the $VERSION variable in the given package) not less than
272NEED; it will die if this is not the case. This method is normally
273called as a class method. This method is called automatically by the
274C<VERSION> form of C<use>.
5f05dabc 275
276 use A 1.2 qw(some imported subs);
71be2cbc 277 # implies:
278 A->VERSION(1.2);
5f05dabc 279
280=item class()
281
282C<class> returns the class name of its object.
283
284=item is_instance()
285
286C<is_instance> returns true if its object is an instance of some
287class, false if its object is the class (package) itself. Example
288
289 A->is_instance(); # False
290
291 $var = 'A';
292 $var->is_instance(); # False
293
294 $ref = bless [], 'A';
295 $ref->is_instance(); # True
296
774d564b 297This can be useful for methods that wish to easily distinguish
298whether they were invoked as class or as instance methods.
299
300 sub some_meth {
301 my $classname = shift;
302 if ($classname->is_instance()) {
303 die "unexpectedly called as instance not class method";
304 }
305 .....
306 }
307
5f05dabc 308=back
309
310B<NOTE:> C<can> directly uses Perl's internal code for method lookup, and
774d564b 311C<isa> uses a very similar method and caching strategy. This may cause
5f05dabc 312strange effects if the Perl code dynamically changes @ISA in any package.
313
314You may add other methods to the UNIVERSAL class via Perl or XS code.
315You do not need to C<use UNIVERSAL> in order to make these methods
316available to your program. This is necessary only if you wish to
317have C<isa> available as a plain subroutine in the current package.
318
319=head2 TIEHANDLE Now Supported
320
774d564b 321See L<perltie> for other kinds of tie()s.
322
5f05dabc 323=over
324
325=item TIEHANDLE classname, LIST
326
327This is the constructor for the class. That means it is expected to
328return an object of some sort. The reference can be used to
329hold some internal information.
330
774d564b 331 sub TIEHANDLE {
332 print "<shout>\n";
333 my $i;
334 return bless \$i, shift;
335 }
5f05dabc 336
337=item PRINT this, LIST
338
339This method will be triggered every time the tied handle is printed to.
340Beyond its self reference it also expects the list that was passed to
341the print function.
342
774d564b 343 sub PRINT {
344 $r = shift;
345 $$r++;
346 return print join( $, => map {uc} @_), $\;
347 }
5f05dabc 348
349=item READLINE this
350
351This method will be called when the handle is read from. The method
352should return undef when there is no more data.
353
774d564b 354 sub READLINE {
355 $r = shift;
356 return "PRINT called $$r times\n";
357 }
5f05dabc 358
359=item DESTROY this
360
361As with the other types of ties, this method will be called when the
362tied handle is about to be destroyed. This is useful for debugging and
363possibly for cleaning up.
364
774d564b 365 sub DESTROY {
366 print "</shout>\n";
367 }
5f05dabc 368
369=back
370
774d564b 371=item Efficiency Enhancements
372
373All hash keys with the same string are only allocated once, so
374even if you have 100 copies of the same hash, the immutable keys
375never have to be re-allocated.
376
377Functions that have an empty prototype and that do nothing but return
378a fixed value are now inlined (e.g. C<sub PI () { 3.14159 }>).
379
5f05dabc 380=head1 Pragmata
381
382Three new pragmatic modules exist:
383
384=over
385
386=item use blib
387
774d564b 388=item use blib 'dir'
389
5f05dabc 390Looks for MakeMaker-like I<'blib'> directory structure starting in
391I<dir> (or current directory) and working back up to five levels of
392parent directories.
393
394Intended for use on command line with B<-M> option as a way of testing
395arbitrary scripts against an uninstalled version of a package.
396
397=item use locale
398
399Tells the compiler to enable (or disable) the use of POSIX locales for
400built-in operations.
401
402When C<use locale> is in effect, the current LC_CTYPE locale is used
403for regular expressions and case mapping; LC_COLLATE for string
404ordering; and LC_NUMERIC for numeric formating in printf and sprintf
405(but B<not> in print). LC_NUMERIC is always used in write, since
406lexical scoping of formats is problematic at best.
407
408Each C<use locale> or C<no locale> affects statements to the end of
409the enclosing BLOCK or, if not inside a BLOCK, to the end of the
410current file. Locales can be switched and queried with
411POSIX::setlocale().
412
413See L<perllocale> for more information.
414
415=item use ops
416
7cfe7857 417Disable unsafe opcodes, or any named opcodes, when compiling Perl code.
5f05dabc 418
419=back
420
421=head1 Modules
422
774d564b 423=head2 Fcntl
424
425New constants in the existing Fcntl modules are now supported,
426provided that your operating system happens to support them:
427
428 F_GETOWN F_SETOWN
429 O_ASYNC O_DEFER O_DSYNC O_FSYNC O_SYNC
430 O_EXLOCK O_SHLOCK
431
5f05dabc 432=head2 Module Information Summary
433
774d564b 434Brand new modules, arranged by topic rather than strictly
435alphabetically:
436
437 CPAN interface to Comprehensive Perl Archive Network
438 CPAN::FirstTime create a CPAN configuration file
439 CPAN::Nox run CPAN while avoiding compiled extensions
5f05dabc 440
441 IO.pm Top-level interface to IO::* classes
442 IO/File.pm IO::File extension Perl module
443 IO/Handle.pm IO::Handle extension Perl module
444 IO/Pipe.pm IO::Pipe extension Perl module
445 IO/Seekable.pm IO::Seekable extension Perl module
446 IO/Select.pm IO::Select extension Perl module
447 IO/Socket.pm IO::Socket extension Perl module
448
449 Opcode.pm Disable named opcodes when compiling Perl code
450
451 ExtUtils/Embed.pm Utilities for embedding Perl in C programs
452 ExtUtils/testlib.pm Fixes up @INC to use just-built extension
453
454 Fatal.pm Make do-or-die equivalents of functions
455 FindBin.pm Find path of currently executing program
456
457 Class/Template.pm Structure/member template builder
458 File/stat.pm Object-oriented wrapper around CORE::stat
459 Net/hostent.pm Object-oriented wrapper around CORE::gethost*
460 Net/netent.pm Object-oriented wrapper around CORE::getnet*
461 Net/protoent.pm Object-oriented wrapper around CORE::getproto*
462 Net/servent.pm Object-oriented wrapper around CORE::getserv*
463 Time/gmtime.pm Object-oriented wrapper around CORE::gmtime
464 Time/localtime.pm Object-oriented wrapper around CORE::localtime
465 Time/tm.pm Perl implementation of "struct tm" for {gm,local}time
466 User/grent.pm Object-oriented wrapper around CORE::getgr*
467 User/pwent.pm Object-oriented wrapper around CORE::getpw*
468
774d564b 469 Tie/RefHash.pm Base class for tied hashes with references as keys
7a4c00b4 470
5f05dabc 471 UNIVERSAL.pm Base class for *ALL* classes
472
473=head2 IO
474
475The IO module provides a simple mechanism to load all of the IO modules at one
476go. Currently this includes:
477
478 IO::Handle
479 IO::Seekable
480 IO::File
481 IO::Pipe
482 IO::Socket
483
484For more information on any of these modules, please see its
485respective documentation.
486
487=head2 Math::Complex
488
489The Math::Complex module has been totally rewritten, and now supports
490more operations. These are overloaded:
491
492 + - * / ** <=> neg ~ abs sqrt exp log sin cos atan2 "" (stringify)
493
494And these functions are now exported:
495
496 pi i Re Im arg
497 log10 logn cbrt root
498 tan cotan asin acos atan acotan
499 sinh cosh tanh cotanh asinh acosh atanh acotanh
500 cplx cplxe
501
502=head2 Overridden Built-ins
503
504Many of the Perl built-ins returning lists now have
505object-oriented overrides. These are:
506
507 File::stat
508 Net::hostent
509 Net::netent
510 Net::protoent
511 Net::servent
512 Time::gmtime
513 Time::localtime
514 User::grent
515 User::pwent
516
517For example, you can now say
518
519 use File::stat;
520 use User::pwent;
521 $his = (stat($filename)->st_uid == pwent($whoever)->pw_uid);
522
774d564b 523=head1 Utility Changes
5f05dabc 524
774d564b 525=head2 xsubpp
5f05dabc 526
774d564b 527=item C<void> XSUBs now default to returning nothing
528
529Due to a documentation/implementation bug in previous versions of
530Perl, XSUBs with a return type of C<void> have actually been
531returning one value. Usually that value was the GV for the XSUB,
532but sometimes it was some already freed or reused value, which would
533sometimes lead to program failure.
534
535In Perl 5.004, if an XSUB is declared as returning C<void>, it
536actually returns no value, i.e. an empty list (though there is a
537backward-compatibility exception; see below). If your XSUB really
538does return an SV, you should give it a return type of C<SV *>.
539
540For backward compatibility, I<xsubpp> tries to guess whether a
541C<void> XSUB is really C<void> or if it wants to return an C<SV *>.
542It does so by examining the text of the XSUB: if I<xsubpp> finds
543what looks like an assignment to C<ST(0)>, it assumes that the
544XSUB's return type is really C<SV *>.
5f05dabc 545
546=head1 Documentation Changes
547
548Many of the base and library pods were updated. These
549new pods are included in section 1:
550
551=over 4
552
774d564b 553=item L<perldelta>
5f05dabc 554
71be2cbc 555This document.
5f05dabc 556
71be2cbc 557=item L<perllocale>
5f05dabc 558
71be2cbc 559Locale support (internationalization and localization).
5f05dabc 560
561=item L<perltoot>
562
563Tutorial on Perl OO programming.
564
71be2cbc 565=item L<perlapio>
566
567Perl internal IO abstraction interface.
568
5f05dabc 569=item L<perldebug>
570
571Although not new, this has been massively updated.
572
573=item L<perlsec>
574
575Although not new, this has been massively updated.
576
577=back
578
579=head1 New Diagnostics
580
581Several new conditions will trigger warnings that were
582silent before. Some only affect certain platforms.
774d564b 583The following new warnings and errors outline these.
584These messages are classified as follows (listed in
585increasing order of desperation):
586
587 (W) A warning (optional).
588 (D) A deprecation (optional).
589 (S) A severe warning (mandatory).
590 (F) A fatal error (trappable).
591 (P) An internal error you should never see (trappable).
592 (X) A very fatal error (non-trappable).
593 (A) An alien error message (not generated by Perl).
5f05dabc 594
595=over 4
596
597=item "my" variable %s masks earlier declaration in same scope
598
599(S) A lexical variable has been redeclared in the same scope, effectively
600eliminating all access to the previous instance. This is almost always
601a typographical error. Note that the earlier variable will still exist
602until the end of the scope or until all closure referents to it are
603destroyed.
604
774d564b 605=item %s argument is not a HASH element or slice
606
607(F) The argument to delete() must be either a hash element, such as
608
609 $foo{$bar}
610 $ref->[12]->{"susie"}
611
612or a hash slice, such as
613
614 @foo{$bar, $baz, $xyzzy}
615 @{$ref->[12]}{"susie", "queue"}
616
5f05dabc 617=item Allocation too large: %lx
618
619(X) You can't allocate more than 64K on an MSDOS machine.
620
621=item Allocation too large
622
623(F) You can't allocate more than 2^31+"small amount" bytes.
624
625=item Attempt to free non-existent shared string
626
627(P) Perl maintains a reference counted internal table of strings to
628optimize the storage and access of hash keys and other strings. This
629indicates someone tried to decrement the reference count of a string
630that can no longer be found in the table.
631
632=item Attempt to use reference as lvalue in substr
633
634(W) You supplied a reference as the first argument to substr() used
635as an lvalue, which is pretty strange. Perhaps you forgot to
636dereference it first. See L<perlfunc/substr>.
637
638=item Unsupported function fork
639
640(F) Your version of executable does not support forking.
641
642Note that under some systems, like OS/2, there may be different flavors of
643Perl executables, some of which may support fork, some not. Try changing
644the name you call Perl by to C<perl_>, C<perl__>, and so on.
645
646=item Ill-formed logical name |%s| in prime_env_iter
647
648(W) A warning peculiar to VMS. A logical name was encountered when preparing
649to iterate over %ENV which violates the syntactic rules governing logical
650names. Since it cannot be translated normally, it is skipped, and will not
651appear in %ENV. This may be a benign occurrence, as some software packages
652might directly modify logical name tables and introduce non-standard names,
653or it may indicate that a logical name table has been corrupted.
654
774d564b 655=item Can't use bareword ("%s") as %s ref while "strict refs" in use
656
657(F) Only hard references are allowed by "strict refs". Symbolic references
658are disallowed. See L<perlref>.
659
660=item Constant subroutine %s redefined
661
662(S) You redefined a subroutine which had previously been eligible for
663inlining. See L<perlsub/"Constant Functions"> for commentary and
664workarounds.
665
666=item Died
667
668(F) You passed die() an empty string (the equivalent of C<die "">) or
669you called it with no args and both C<$@> and C<$_> were empty.
670
5f05dabc 671=item Integer overflow in hex number
672
673(S) The literal hex number you have specified is too big for your
674architecture. On a 32-bit architecture the largest hex literal is
6750xFFFFFFFF.
676
677=item Integer overflow in octal number
678
679(S) The literal octal number you have specified is too big for your
680architecture. On a 32-bit architecture the largest octal literal is
681037777777777.
682
774d564b 683=item Name "%s::%s" used only once: possible typo
684
685(W) Typographical errors often show up as unique variable names.
686If you had a good reason for having a unique name, then just mention
687it again somehow to suppress the message (the C<use vars> pragma is
688provided for just this purpose).
689
5f05dabc 690=item Null picture in formline
691
692(F) The first argument to formline must be a valid format picture
693specification. It was found to be empty, which probably means you
694supplied it an uninitialized value. See L<perlform>.
695
696=item Offset outside string
697
698(F) You tried to do a read/write/send/recv operation with an offset
699pointing outside the buffer. This is difficult to imagine.
700The sole exception to this is that C<sysread()>ing past the buffer
701will extend the buffer and zero pad the new area.
702
774d564b 703=item Stub found while resolving method `%s' overloading `%s' in package `%s'
704
705(P) Overloading resolution over @ISA tree may be broken by importing stubs.
706Stubs should never be implicitely created, but explicit calls to C<can>
707may break this.
708
709=item Cannot resolve method `%s' overloading `%s' in package `s'
710
711(P) Internal error trying to resolve overloading specified by a method
712name (as opposed to a subroutine reference).
713
5f05dabc 714=item Out of memory!
715
716(X|F) The malloc() function returned 0, indicating there was insufficient
717remaining memory (or virtual memory) to satisfy the request.
718
719The request was judged to be small, so the possibility to trap it
720depends on the way Perl was compiled. By default it is not trappable.
721However, if compiled for this, Perl may use the contents of C<$^M> as
722an emergency pool after die()ing with this message. In this case the
723error is trappable I<once>.
724
725=item Out of memory during request for %s
726
727(F) The malloc() function returned 0, indicating there was insufficient
728remaining memory (or virtual memory) to satisfy the request. However,
729the request was judged large enough (compile-time default is 64K), so
730a possibility to shut down by trapping this error is granted.
731
732=item Possible attempt to put comments in qw() list
733
774d564b 734(W) qw() lists contain items separated by whitespace; as with literal
735strings, comment characters are not ignored, but are instead treated
736as literal data. (You may have used different delimiters than the
737exclamation marks parentheses shown here; braces are also frequently
738used.)
739
740You probably wrote something like this:
5f05dabc 741
774d564b 742 @list = qw(
743 a # a comment
5f05dabc 744 b # another comment
774d564b 745 );
5f05dabc 746
747when you should have written this:
748
774d564b 749 @list = qw(
750 a
5f05dabc 751 b
774d564b 752 );
753
754If you really want comments, build your list the
755old-fashioned way, with quotes and commas:
756
757 @list = (
758 'a', # a comment
759 'b', # another comment
760 );
5f05dabc 761
762=item Possible attempt to separate words with commas
763
774d564b 764(W) qw() lists contain items separated by whitespace; therefore commas
765aren't needed to separate the items. (You may have used different
766delimiters than the parentheses shown here; braces are also frequently
767used.)
5f05dabc 768
774d564b 769You probably wrote something like this:
5f05dabc 770
774d564b 771 qw! a, b, c !;
772
773which puts literal commas into some of the list items. Write it without
774commas if you don't want them to appear in your data:
775
776 qw! a b c !;
5f05dabc 777
774d564b 778=item Scalar value @%s{%s} better written as $%s{%s}
779
780(W) You've used a hash slice (indicated by @) to select a single element of
781a hash. Generally it's better to ask for a scalar value (indicated by $).
782The difference is that C<$foo{&bar}> always behaves like a scalar, both when
783assigning to it and when evaluating its argument, while C<@foo{&bar}> behaves
784like a list when you assign to it, and provides a list context to its
785subscript, which can do weird things if you're expecting only one subscript.
5f05dabc 786
787=item untie attempted while %d inner references still exist
788
789(W) A copy of the object returned from C<tie> (or C<tied>) was still
790valid when C<untie> was called.
791
774d564b 792=item Value of %s construct can be "0"; test with defined()
793
794(W) In a conditional expression, you used <HANDLE>, <*> (glob), or
795C<readdir> as a boolean value. Each of these constructs can return a
796value of "0"; that would make the conditional expression false, which
797is probably not what you intended. When using these constructs in
798conditional expressions, test their values with the C<defined> operator.
799
800=item Variable "%s" may be unavailable
801
802(W) An inner (nested) I<anonymous> subroutine is inside a I<named>
803subroutine, and outside that is another subroutine; and the anonymous
804(innermost) subroutine is referencing a lexical variable defined in
805the outermost subroutine. For example:
806
807 sub outermost { my $a; sub middle { sub { $a } } }
808
809If the anonymous subroutine is called or referenced (directly or
810indirectly) from the outermost subroutine, it will share the variable
811as you would expect. But if the anonymous subroutine is called or
812referenced when the outermost subroutine is not active, it will see
813the value of the shared variable as it was before and during the
814*first* call to the outermost subroutine, which is probably not what
815you want.
816
817In these circumstances, it is usually best to make the middle
818subroutine anonymous, using the C<sub {}> syntax. Perl has specific
819support for shared variables in nested anonymous subroutines; a named
820subroutine in between interferes with this feature.
821
822=item Variable "%s" will not stay shared
823
824(W) An inner (nested) I<named> subroutine is referencing a lexical
825variable defined in an outer subroutine.
826
827When the inner subroutine is called, it will probably see the value of
828the outer subroutine's variable as it was before and during the
829*first* call to the outer subroutine; in this case, after the first
830call to the outer subroutine is complete, the inner and outer
831subroutines will no longer share a common value for the variable. In
832other words, the variable will no longer be shared.
833
834Furthermore, if the outer subroutine is anonymous and references a
835lexical variable outside itself, then the outer and inner subroutines
836will I<never> share the given variable.
837
838This problem can usually be solved by making the inner subroutine
839anonymous, using the C<sub {}> syntax. When inner anonymous subs that
840reference variables in outer subroutines are called or referenced,
841they are automatically re-bound to the current values of such
842variables.
843
844=item Warning: something's wrong
845
846(W) You passed warn() an empty string (the equivalent of C<warn "">) or
847you called it with no args and C<$_> was empty.
848
849=item Got an error from DosAllocMem
5f05dabc 850
774d564b 851(P) An error peculiar to OS/2. Most probably you're using an obsolete
852version of Perl, and this should not happen anyway.
5f05dabc 853
854=item Malformed PERLLIB_PREFIX
855
856(F) An error peculiar to OS/2. PERLLIB_PREFIX should be of the form
857
858 prefix1;prefix2
859
860or
861
862 prefix1 prefix2
863
864with non-empty prefix1 and prefix2. If C<prefix1> is indeed a prefix of
865a builtin library search path, prefix2 is substituted. The error may appear
866if components are not found, or are too long. See L<perlos2/"PERLLIB_PREFIX">.
867
868=item PERL_SH_DIR too long
869
870(F) An error peculiar to OS/2. PERL_SH_DIR is the directory to find the
871C<sh>-shell in. See L<perlos2/"PERL_SH_DIR">.
872
873=item Process terminated by SIG%s
874
875(W) This is a standard message issued by OS/2 applications, while *nix
876applications die in silence. It is considered a feature of the OS/2
877port. One can easily disable this by appropriate sighandlers, see
878L<perlipc/"Signals">. See L<perlos2/"Process terminated by SIGTERM/SIGINT">.
879
880=back
881
882=head1 BUGS
883
774d564b 884If you find what you think is a bug, you might check the headers of
885recently posted articles in the comp.lang.perl.misc newsgroup.
886There may also be information at http://www.perl.com/perl/, the Perl
887Home Page.
5f05dabc 888
889If you believe you have an unreported bug, please run the B<perlbug>
890program included with your release. Make sure you trim your bug
891down to a tiny but sufficient test case. Your bug report, along
892with the output of C<perl -V>, will be sent off to perlbug@perl.com
893to be analysed by the Perl porting team.
894
895=head1 SEE ALSO
896
897The F<Changes> file for exhaustive details on what changed.
898
899The F<INSTALL> file for how to build Perl. This file has been
900significantly updated for 5.004, so even veteran users should
901look through it.
902
903The F<README> file for general stuff.
904
905The F<Copying> file for copyright information.
906
907=head1 HISTORY
908
909Constructed by Tom Christiansen, grabbing material with permission
910from innumerable contributors, with kibitzing by more than a few Perl
911porters.
912
44a8e56a 913Last update: Tue Jan 14 14:03:02 EST 1997