more Compiler tweaks for useithreads
[p5sagit/p5-mst-13.2.git] / pod / perldelta.pod
CommitLineData
ba8251e8 1=head1 NAME
2
40b7eeef 3perldelta - what's new for perl v5.6 (as of v5.005_64)
ba8251e8 4
5=head1 DESCRIPTION
6
f29c64d6 7This is an unsupported alpha release, meant for intrepid Perl developers
8only. The included sources may not even build correctly on some platforms.
9Subscribing to perl5-porters is the best way to monitor and contribute
10to the progress of development releases (see www.perl.org for info).
11
ba8251e8 12This document describes differences between the 5.005 release and this one.
13
14=head1 Incompatible Changes
15
e02fdbd2 16=head2 Perl Source Incompatibilities
17
40b7eeef 18Beware that any new warnings that have been added or old ones
19that have been enhanced are B<not> considered incompatible changes.
a5222a85 20
21Since all new warnings must be explicitly requested via the C<-w>
22switch or the C<warnings> pragma, it is ultimately the programmer's
23responsibility to ensure that warnings are enabled judiciously.
e02fdbd2 24
757edf6f 25=over 4
26
7d30b5c4 27=item CHECK is a new keyword
4f25aa18 28
40b7eeef 29In addition to C<BEGIN>, C<INIT>, C<END>, C<DESTROY> and C<AUTOLOAD>,
7d30b5c4 30subroutines named C<CHECK> are now special. These are queued up during
0536e0eb 31compilation and behave similar to END blocks, except they are called at
32the end of compilation rather than at the end of execution. They cannot
33be called directly.
4f25aa18 34
08cd8952 35=item Treatment of list slices of undef has changed
36
37When taking a slice of a literal list (as opposed to a slice of
38an array or hash), Perl used to return an empty list if the
39result happened to be composed of all undef values.
40
41The new behavior is to produce an empty list if (and only if)
42the original list was empty. Consider the following example:
43
44 @a = (1,undef,undef,2)[2,1,2];
45
46The old behavior would have resulted in @a having no elements.
47The new behavior ensures it has three undefined elements.
48
49Note in particular that the behavior of slices of the following
50cases remains unchanged:
51
52 @a = ()[1,2];
53 @a = (getpwent)[7,0];
54 @a = (anything_returning_empty_list())[2,1,2];
55 @a = @b[2,1,2];
56 @a = @c{'a','b','c'};
57
58See L<perldata>.
59
44dcb63b 60=head2 Perl's version numbering has changed
61
62Beginning with Perl version 5.6, the version number convention has been
63changed to a "dotted integer" scheme that is more commonly found in open
64source projects.
65
66Maintenance versions of v5.6.0 will be released as v5.6.1, v5.6.2 etc.
67The next development series following v5.6 will be numbered v5.7.x,
68beginning with v5.7.0, and the next major production release following
69v5.6 will be v5.8.
70
71The English module now sets $PERL_VERSION to $^V (a string value) rather
72than C<$]> (a numeric value). (This is a potential incompatibility.
73Send us a report via perlbug if you are affected by this.)
74
75The v1.2.3 syntax is also now legal in Perl.
76See L<Support for strings represented as a vector of ordinals> for more on that.
77
78To cope with the new versioning system's use of at least three significant
79digits for each version component, the method used for incrementing the
80subversion number has also changed slightly. We assume that versions older
81than v5.6 have been incrementing the subversion component in multiples of
8210. Versions after v5.6.0 will increment them by 1. Thus, using the new
83notation, 5.005_03 is the same as v5.5.30, and the first maintenance
84version following v5.6.0 will be v5.6.1, which amounts to a floating point
85value of 5.006_001).
86
dd629d5b 87=item Literals of the form C<1.2.3> parse differently
88
89Previously, numeric literals with more than one dot in them were
90interpreted as a floating point number concatenated with one or more
91numbers. Such "numbers" are now parsed as strings composed of the
92specified ordinals.
93
94For example, C<print 97.98.99> used to output C<97.9899> in earlier
95versions, but now prints C<abc>.
96
97See L<Support for strings represented as a vector of ordinals> below.
98
757edf6f 99=item Possibly changed pseudo-random number generator
100
101In 5.005_0x and earlier, perl's rand() function used the C library
102rand(3) function. As of 5.005_52, Configure tests for drand48(),
103random(), and rand() (in that order) and picks the first one it finds.
104Perl programs that depend on reproducing a specific set of pseudo-random
c35dd67d 105numbers will now likely produce different output. You can use
106C<sh Configure -Drandfunc=rand> to obtain the old behavior.
757edf6f 107
a5222a85 108=item Hashing function for hash keys has changed
109
110Perl hashes are not order preserving. The apparently random order
111encountered when iterating on the contents of a hash is determined
112by the hashing algorithm used. To improve the distribution of lower
113bits in the hashed value, the algorithm has changed slightly as of
1145.005_52. When iterating over hashes, this may yield a random order
115that is B<different> from that of previous versions.
116
117=item C<undef> fails on read only values
118
119Using the C<undef> operator on a readonly value (such as $1) has
120the same effect as assigning C<undef> to the readonly value--it
121throws an exception.
122
8d2a6795 123=item Close-on-exec bit may be set on pipe and socket handles
a5222a85 124
125On systems that support a close-on-exec flag on filehandles, the
8d2a6795 126flag will be set for any handles created by pipe(), socketpair(),
127socket(), and accept(), if that is warranted by the value of $^F
128that may be in effect. Earlier versions neglected to set the flag
129for handles created with these operators. See L<perlfunc/pipe>,
130L<perlfunc/socketpair>, L<perlfunc/socket>, L<perlfunc/accept>,
131and L<perlvar/$^F>.
a5222a85 132
133=item Writing C<"$$1"> to mean C<"${$}1"> is unsupported
134
135Perl 5.004 deprecated the interpretation of C<$$1> and
136similar within interpolated strings to mean C<$$ . "1">,
137but still allowed it.
138
139In Perl 5.6 and later, C<"$$1"> always means C<"${$1}">.
140
94f7643d 141=item delete(), values() and C<\(%h)> operate on aliases to values, not copies
a5222a85 142
94f7643d 143delete(), each(), values() and hashes in a list context return the actual
a5222a85 144values in the hash, instead of copies (as they used to in earlier
145versions). Typical idioms for using these constructs copy the
501fbaef 146returned values, but this can make a significant difference when
a5222a85 147creating references to the returned values.
148
149Keys in the hash are still returned as copies when iterating on
08cd8952 150a hash.
a5222a85 151
152=item vec(EXPR,OFFSET,BITS) enforces powers-of-two BITS
153
08cd8952 154vec() generates a run-time error if the BITS argument is not
a5222a85 155a valid power-of-two integer.
156
157=item Text of some diagnostic output has changed
158
159Most references to internal Perl operations in diagnostics
160have been changed to be more descriptive. This may be an
161issue for programs that may incorrectly rely on the exact
162text of diagnostics for proper functioning.
163
164=item C<%@> has been removed
165
166The undocumented special variable C<%@> that used to accumulate
167"background" errors (such as those that happen in DESTROY())
168has been removed, because it could potentially result in memory
169leaks.
170
39429b3b 171=item Parenthesized not() behaves like a list operator
172
173The C<not> operator now falls under the "if it looks like a function,
174it behaves like a function" rule.
175
176As a result, the parenthesized form can be used with C<grep> and C<map>.
177The following construct used to be a syntax error before, but it works
178as expected now:
179
180 grep not($_), @things;
181
182On the other hand, using C<not> with a literal list slice may not
183work. The following previously allowed construct:
184
185 print not (1,2,3)[0];
186
af365420 187needs to be written with additional parentheses now:
39429b3b 188
189 print not((1,2,3)[0]);
190
191The behavior remains unaffected when C<not> is not followed by parentheses.
192
0df79f0c 193=item Semantics of bareword prototype C<(*)> have changed
194
195Arguments prototyped as C<*> will now be visible within the subroutine
196as either a simple scalar or as a reference to a typeglob. Perl 5.005
197always coerced simple scalar arguments to a typeglob, which wasn't useful
198in situations where the subroutine must distinguish between a simple
199scalar and a typeglob. See L<perlsub/Prototypes>.
200
757edf6f 201=back
202
e02fdbd2 203=head2 C Source Incompatibilities
204
205=over 4
206
207=item C<PERL_POLLUTE>
208
209Release 5.005 grandfathered old global symbol names by providing preprocessor
87275199 210macros for extension source compatibility. As of release 5.6, these
e02fdbd2 211preprocessor definitions are not available by default. You need to explicitly
14218588 212compile perl with C<-DPERL_POLLUTE> to get these definitions. For
213extensions still using the old symbols, this option can be
2aea4d40 214specified via MakeMaker:
215
14218588 216 perl Makefile.PL POLLUTE=1
e02fdbd2 217
f29c64d6 218=item C<PERL_IMPLICIT_CONTEXT>
219
af365420 220PERL_IMPLICIT_CONTEXT is automatically enabled whenever Perl is built
221with one of -Dusethreads, -Dusemultiplicity, or both. It is not
222intended to be enabled by users at this time.
223
f29c64d6 224This new build option provides a set of macros for all API functions
225such that an implicit interpreter/thread context argument is passed to
226every API function. As a result of this, something like C<sv_setsv(foo,bar)>
2c2d71f5 227amounts to a macro invocation that actually translates to something like
f29c64d6 228C<Perl_sv_setsv(my_perl,foo,bar)>. While this is generally expected
229to not have any significant source compatibility issues, the difference
230between a macro and a real function call will need to be considered.
231
2c2d71f5 232This means that there B<is> a source compatibility issue as a result of
233this if your extensions attempt to use pointers to any of the Perl API
234functions.
235
f29c64d6 236Note that the above issue is not relevant to the default build of
237Perl, whose interfaces continue to match those of prior versions
238(but subject to the other options described here).
239
2c2d71f5 240See L<perlguts/"The Perl API"> for detailed information on the
241ramifications of building Perl using this option.
242
86058a2d 243=item C<PERL_POLLUTE_MALLOC>
244
14218588 245Enabling Perl's malloc in release 5.005 and earlier caused
86058a2d 246the namespace of system versions of the malloc family of functions to
14218588 247be usurped by the Perl versions, since by default they used the
248same names.
86058a2d 249
250Besides causing problems on platforms that do not allow these functions to
251be cleanly replaced, this also meant that the system versions could not
252be called in programs that used Perl's malloc. Previous versions of Perl
14218588 253have allowed this behaviour to be suppressed with the HIDEMYMALLOC and
86058a2d 254EMBEDMYMALLOC preprocessor definitions.
255
87275199 256As of release 5.6, Perl's malloc family of functions have default names
86058a2d 257distinct from the system versions. You need to explicitly compile perl with
14218588 258C<-DPERL_POLLUTE_MALLOC> to get the older behaviour. HIDEMYMALLOC
259and EMBEDMYMALLOC have no effect, since the behaviour they enabled is now
86058a2d 260the default.
261
262Note that these functions do B<not> constitute Perl's memory allocation API.
263See L<perlguts/"Memory Allocation"> for further information about that.
264
e02fdbd2 265=back
266
cceca5ed 267=head2 Compatible C Source API Changes
268
269=over
270
271=item C<PATCHLEVEL> is now C<PERL_VERSION>
272
14218588 273The cpp macros C<PERL_REVISION>, C<PERL_VERSION>, and C<PERL_SUBVERSION>
cceca5ed 274are now available by default from perl.h, and reflect the base revision,
14218588 275patchlevel, and subversion respectively. C<PERL_REVISION> had no
cceca5ed 276prior equivalent, while C<PERL_VERSION> and C<PERL_SUBVERSION> were
277previously available as C<PATCHLEVEL> and C<SUBVERSION>.
278
14218588 279The new names cause less pollution of the B<cpp> namespace and reflect what
cceca5ed 280the numbers have come to stand for in common practice. For compatibility,
14218588 281the old names are still supported when F<patchlevel.h> is explicitly
cceca5ed 282included (as required before), so there is no source incompatibility
14218588 283from the change.
cceca5ed 284
a5222a85 285=item Support for C++ exceptions
286
287change#3386, also needs perlguts documentation
288[TODO - Chip Salzenberg <chip@perlsupport.com>]
289
cceca5ed 290=back
291
e02fdbd2 292=head2 Binary Incompatibilities
293
ed09ebcd 294In general, the default build of this release is expected to be binary
295compatible for extensions built with the 5.005 release or its maintenance
296versions. However, specific platforms may have broken binary compatibility
297due to changes in the defaults used in hints files. Therefore, please be
298sure to always check the platform-specific README files for any notes to
299the contrary.
f29c64d6 300
301The usethreads or usemultiplicity builds are B<not> binary compatible
302with the corresponding builds in 5.005.
e02fdbd2 303
ed09ebcd 304On platforms that require an explicit list of exports (AIX, OS/2 and Windows,
305among others), purely internal symbols such as parser functions and the
306run time opcodes are not exported by default. Perl 5.005 used to export
307all functions irrespective of whether they were considered part of the
308public API or not.
309
310For the full list of public API functions, see L<perlapi>.
311
a5222a85 312=head1 Installation and Configuration Improvements
313
16070b82 314=head2 -Dusethreads means something different
315
316WARNING: Support for threads continues to be an experimental feature.
317Interfaces and implementation are subject to sudden and drastic changes.
318
319The -Dusethreads flag now enables the experimental interpreter-based thread
320support by default. To get the flavor of experimental threads that was in
3215.005 instead, you need to ask for -Duse5005threads.
322
323As of v5.5.640, interpreter-threads support is still lacking a way to
324create new threads from Perl (i.e., C<use Thread;> will not work with
325interpreter threads). C<use Thread;> continues to be available when you
326ask for -Duse5005threads, bugs and all.
327
a5222a85 328=head2 New Configure flags
329
330The following new flags may be enabled on the Configure command line
331by running Configure with C<-Dflag>.
332
333 usemultiplicity
16070b82 334 use5005threads
67d3893f 335
336 uselongdouble
a5222a85 337 usemorebits
338 uselargefiles
a5222a85 339
67d3893f 340=head2 -Dusethreads and -Duse64bits now more daring
341
342The Configure options enabling the use of threads and the use of
132ca540 34364-bitness are now more daring in the sense that they no more have an
344explicit list of operating systems of known threads/64-bit
67d3893f 345capabilities. In other words: if your operating system has the
132ca540 346necessary APIs and datatypes, you should be able just to go ahead and
347use them, for threads by Configure -Dusethreads, and for 64 bits
348either explicitly by Configure -Duse64bits or implicitly if your
349system has 64 bit wide datatypes. See also L<"64-bit support">.
67d3893f 350
351=head2 Long Doubles
352
353Some platforms have "long doubles", floating point numbers of even
437784d6 354larger range than ordinary "doubles". To enable using long doubles for
67d3893f 355Perl's scalars, use -Duselongdouble.
356
357=head2 -Dusemorebits
358
359You can enable both -Duse64bits and -Dlongdouble by -Dusemorebits.
360See also L<"64-bit support">.
361
362=head2 -Duselargefiles
363
364Some platforms support large files, files larger than two gigabytes.
365See L<"Large file support"> for more information.
a5222a85 366
367=head2 installusrbinperl
368
369You can use "Configure -Uinstallusrbinperl" which causes installperl
370to skip installing perl also as /usr/bin/perl. This is useful if you
371prefer not to modify /usr/bin for some reason or another but harmful
372because many scripts assume to find Perl in /usr/bin/perl.
373
374=head2 SOCKS support
375
376You can use "Configure -Dusesocks" which causes Perl to probe
c35dd67d 377for the SOCKS (v5, not v4) proxy protocol library,
378http://www.socks.nec.com/
a5222a85 379
380=head2 C<-A> flag
381
382You can "post-edit" the Configure variables using the Configure C<-A>
383flag. The editing happens immediately after the platform specific
384hints files have been processed but before the actual configuration
385process starts. Run C<Configure -h> to find out the full C<-A> syntax.
386
c35dd67d 387=head2 Enhanced Installation Directories
67d3893f 388
c35dd67d 389The installation structure has been enriched to improve the support for
390maintaining multiple versions of perl, to provide locations for
391vendor-supplied modules and scripts, and to ease maintenance of
392locally-added modules and scripts. See the section on Installation
393Directories in the INSTALL file for complete details. For most users
394building and installing from source, the defaults should be fine.
67d3893f 395
ba8251e8 396=head1 Core Changes
397
9d73390d 398=head2 Unicode and UTF-8 support
399
400Perl can optionally use UTF-8 as its internal representation for character
8058d7ab 401strings. The C<utf8> and C<bytes> pragmas are used to control this support
402in the current lexical scope. See L<perlunicode>, L<utf8> and L<bytes> for
393fec97 403more information.
9d73390d 404
16070b82 405=head2 Interpreter cloning, threads, and concurrency
af365420 406
407WARNING: This is an experimental feature in a pre-alpha state. Use
408at your own risk.
409
410Perl 5.005_63 introduces the beginnings of support for running multiple
411interpreters concurrently in different threads. In conjunction with
412the perl_clone() API call, which can be used to selectively duplicate
413the state of any given interpreter, it is possible to compile a
414piece of code once in an interpreter, clone that interpreter
415one or more times, and run all the resulting interpreters in distinct
416threads.
417
418On Windows, this feature is used to emulate fork() at the interpreter
419level. See L<perlfork>.
420
421This feature is still in evolution. It is eventually meant to be used
422to selectively clone a subroutine and data reachable from that
423subroutine in a separate interpreter and run the cloned subroutine
424in a separate thread. Since there is no shared data between the
425interpreters, little or no locking will be needed (unless parts of
426the symbol table are explicitly shared). This is obviously intended
427to be an easy-to-use replacement for the existing threads support.
428
16070b82 429Support for cloning interpreters and interpreter concurrency can be
430enabled using the -Dusethreads Configure option (see win32/Makefile for
431how to enable it on Windows.) The resulting perl executable will be
432functionally identical to one that was built with -Dmultiplicity, but
433the perl_clone() API call will only be available in the former.
af365420 434
16070b82 435-Dusethreads enables, the cpp macros USE_ITHREADS by default, which enables
436Perl source code changes that provide a clear separation between the op tree
437and the data it operates with. The former is considered immutable, and can
438therefore be shared between an interpreter and all of its clones, while the
439latter is considered local to each interpreter, and is therefore copied for
440each clone.
af365420 441
442Note that building Perl with the -Dusemultiplicity Configure option
443is adequate if you wish to run multiple B<independent> interpreters
16070b82 444concurrently in different threads. -Dusethreads only provides the
445additional functionality of the perl_clone() API call and other
446support for running B<cloned> interpreters concurrently.
af365420 447
448[XXX TODO - the Compiler backends may be broken when USE_ITHREADS is
449enabled.]
450
9d73390d 451=head2 Lexically scoped warning categories
452
453You can now control the granularity of warnings emitted by perl at a finer
4438c4b7 454level using the C<use warnings> pragma. See L<warnings> and L<perllexwarn>
0453d815 455for details.
9d73390d 456
a5222a85 457=head2 Lvalue subroutines
458
459WARNING: This is an experimental feature.
460
461change#4081
462[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>,
d4629d6a 463Tuomas Lukka <lukka@iki.fi>)]
a5222a85 464
465=head2 "our" declarations
466
467An "our" declaration introduces a value that can be best understood
468as a lexically scoped symbolic alias to a global variable in the
16070b82 469package that was current where the variable was declared. This is
470mostly useful as an alternative to the C<vars> pragma, but also provides
471the opportunity to introduce typing and other attributes for such
472variables. See L<perlfunc/our>.
473
44dcb63b 474=head2 Support for strings represented as a vector of ordinals
16070b82 475
dd629d5b 476Literals of the form C<v1.2.3.4> are now parsed as a string composed of
44dcb63b 477of characters with the specified ordinals. This is an alternative, more
478readable way to construct (possibly unicode) strings instead of
dd629d5b 479interpolating characters, as in C<"\x{1}\x{2}\x{3}\x{4}">. The leading
480C<v> may be omitted if there are more than two ordinals, so C<1.2.3> is
481parsed the same as C<v1.2.3>.
16070b82 482
44dcb63b 483Strings written in this form are also useful to represent version "numbers".
484It is easy to compare such version "numbers" (which are really just plain
485strings) using any of the usual string comparison operators C<eq>, C<ne>,
486C<lt>, C<gt>, etc., or perform bitwise string operations on them using C<|>,
487C<&>, etc.
16070b82 488
489In conjunction with the new C<$^V> magic variable (which contains
44dcb63b 490the perl version as a string), such literals can be used as a readable way
491to check if you're running a particular version of Perl:
16070b82 492
44dcb63b 493 # this will parse in older versions of Perl also
16070b82 494 if ($^V and $^V gt v5.5.640) {
44dcb63b 495 # new features supported
16070b82 496 }
497
44dcb63b 498C<require> and C<use> also have some special magic to support such literals.
499They will be interpreted as a version rather than as a module name:
16070b82 500
b22c7a20 501 require v5.6.0; # croak if $^V lt v5.6.0
502 use v5.6.0; # same, but croaks at compile-time
a5222a85 503
dd629d5b 504Alternatively, the C<v> may be omitted if there is more than one dot:
505
506 require 5.6.0;
507 use 5.6.0;
508
44dcb63b 509Also, C<sprintf> and C<printf> support the Perl-specific format flag C<%v>
b22c7a20 510to print ordinals of characters in arbitrary strings:
1761cee5 511
b22c7a20 512 printf "v%vd", $^V; # prints current version, such as "v5.5.650"
513 printf "%*vX", ":", $addr; # formats IPv6 address
dd629d5b 514 printf "%*vb", " ", $bits; # displays bitstring
1761cee5 515
44dcb63b 516See L<perlop/"Strings of Character"> for additional information.
517
a5222a85 518=head2 Weak references
519
520WARNING: This is an experimental feature.
521
d4629d6a 522In previous versions of Perl, you couldn't cache objects so as
523to allow them to be deleted if the last reference from outside
524the cache is deleted. The reference in the cache would hold a
525reference count on the object and the objects would never be
526destroyed.
527
528Another familiar problem is with circular references. When an
529object references itself, its reference count would never go
530down to zero, and it would not get destroyed until the program
531is about to exit.
532
533Weak references solve this by allowing you to "weaken" any
534reference, that is, make it not count towards the reference count.
535When the last non-weak reference to an object is deleted, the object
536is destroyed and all the weak references to the object are
537automatically undef-ed.
a5222a85 538
d4629d6a 539To use this feature, you need the WeakRef package from CPAN, which
540contains additional documentation.
541
542change#3385, also need perlguts documentation
543[TODO - Tuomas Lukka <lukka@iki.fi>]
a5222a85 544
becf2bd3 545=head2 File globbing implemented internally
546
547WARNING: This is currently an experimental feature. Interfaces and
548implementation are likely to change.
549
52bb0670 550Perl now uses the File::Glob implementation of the glob() operator
551automatically. This avoids using an external csh process and the
552problems associated with it.
becf2bd3 553
5fdc711f 554=head2 Binary numbers supported
555
4f19785b 556Binary numbers are now supported as literals, in s?printf formats, and
557C<oct()>:
558
14218588 559 $answer = 0b101010;
560 printf "The answer is: %b\n", oct("0b101010");
4f19785b 561
a5222a85 562=head2 Some arrows may be omitted in calls through references
563
564Perl now allows the arrow to be omitted in many constructs
565involving subroutine calls through references. For example,
f91101c9 566C<$foo[10]-E<gt>('foo')> may now be written C<$foo[10]('foo')>.
a5222a85 567This is rather similar to how the arrow may be omitted from
f91101c9 568C<$foo[10]-E<gt>{'foo'}>. Note however, that the arrow is still
569required for C<foo(10)-E<gt>('bar')>.
a5222a85 570
afebc493 571=head2 exists() is supported on subroutine names
572
573The exists() builtin now works on subroutine names. A subroutine
574is considered to exist if it has been declared (even if implicitly).
575See L<perlfunc/exists> for examples.
576
01020589 577=head2 exists() and delete() are supported on array elements
578
579The exists() and delete() builtins now work on simple arrays as well.
580The behavior is similar to that on hash elements.
581
8ea97a1e 582exists() can be used to check whether an array element has been
8216c1fd 583initialized. This avoids autovivifying array elements that don't exist.
584If the array is tied, the EXISTS() method in the corresponding tied
585package will be invoked.
8ea97a1e 586
587delete() may be used to remove an element from the array and return
588it. The array element at that position returns to its unintialized
589state, so that testing for the same element with exists() will return
590false. If the element happens to be the one at the end, the size of
8216c1fd 591the array also shrinks up to the highest element that tests true for
592exists(), or 0 if none such is found. If the array is tied, the DELETE()
593method in the corresponding tied package will be invoked.
01020589 594
595See L<perlfunc/exists> and L<perlfunc/delete> for examples.
596
5fdc711f 597=head2 syswrite() ease-of-use
598
a5222a85 599The length argument of C<syswrite()> has become optional.
600
b1a9ed4a 601=head2 File and directory handles can be autovivified
a5222a85 602
f91101c9 603Similar to how constructs such as C<$x-E<gt>[0]> autovivify a reference,
b1a9ed4a 604handle constructors (open(), opendir(), pipe(), socketpair(), sysopen(),
605socket(), and accept()) now autovivify a file or directory handle
606if the handle passed to them is an uninitialized scalar variable. This
607allows the constructs such as C<open(my $fh, ...)> and C<open(local $fh,...)>
608to be used to create filehandles that will conveniently be closed
609automatically when the scope ends, provided there are no other references
610to them. This largely eliminates the need for typeglobs when opening
611filehandles that must be passed around, as in the following example:
a5222a85 612
613 sub myopen {
614 open my $fh, "@_"
615 or die "Can't open '@_': $!";
616 return $fh;
617 }
618
619 {
620 my $f = myopen("</etc/motd");
621 print <$f>;
622 # $f implicitly closed here
623 }
624
625[TODO - this idiom needs more pod penetration]
6c67e1bb 626
5fdc711f 627=head2 64-bit support
628
9c107f78 629All platforms that have 64-bit integers either (a) natively as longs
630or ints (b) via special compiler flags (c) using long long are able to
631use "quads" (64-integers) as follows:
632
633=over 4
634
a5222a85 635=item *
636
637constants (decimal, hexadecimal, octal, binary) in the code
638
639=item *
9c107f78 640
a5222a85 641arguments to oct() and hex()
9c107f78 642
a5222a85 643=item *
644
645arguments to print(), printf() and sprintf() (flag prefixes ll, L, q)
646
647=item *
9c107f78 648
a5222a85 649printed as such
9c107f78 650
a5222a85 651=item *
652
653pack() and unpack() "q" and "Q" formats
654
655=item *
656
657in basic arithmetics: + - * / %
658
659=item *
1fad5d67 660
a5222a85 661vec() (but see the below note about bit arithmetics)
9c107f78 662
663=back
664
665Note that unless you have the case (a) you will have to configure
666and compile Perl using the -Duse64bits Configure flag.
667
3175b8cd 668Unfortunately bit arithmetics (&, |, ^, ~, <<, >>) for numbers are not
132ca540 66964-bit clean, they are explictly forced to be 32-bit because of
670tangled backward compatibility issues. This limitation is subject to
671change. Bit arithmetics for bit vector scalars (created by vec()) are
99819a14 672not limited in their width, you can use the & | ^ ~ operators on such
673scalars.
d0ba1bd2 674
2d4389e4 675Last but not least: note that due to Perl's habit of always using
d0ba1bd2 676floating point numbers the quads are still not true integers.
677When quads overflow their limits (0...18_446_744_073_709_551_615 unsigned,
678-9_223_372_036_854_775_808...9_223_372_036_854_775_807 signed), they
679are silently promoted to floating point numbers, after which they will
680start losing precision (their lower digits).
2d4389e4 681
682=head2 Large file support
683
684If you have filesystems that support "large files" (files larger than
aa855319 6852 gigabytes), you may now also be able to create and access them from
249b38c6 686Perl. You have to use Configure -Duselargefiles. Turning on the
822ba51d 687large file support turns on also the 64-bit support on many platforms.
688Beware that unless your filesystem also supports "sparse files" seeking
689to umpteen petabytes may be unadvisable.
2d4389e4 690
eed7fde4 691Note that in addition to requiring a proper file system to do large
692files you may also need to adjust your per-process (or your
693per-system, or per-process-group, or per-user-group) maximum filesize
694limits before running Perl scripts that try to handle large files,
695especially if you intend to write such files.
696
697Finally, in addition to your process/process group maximum filesize
698limits, you may have quota limits on your filesystems that stop you
699(your user id or your user group id) from using large files.
700
701Adjusting your process/user/group/file system/operating system limits
702is outside the scope of Perl core language. For process limits, you
703may try increasing the limits using your shell's limits/limit/ulimit
704command before running Perl. The BSD::Resource extension (not
705included with the standard Perl distribution) may also be of use, it
706offers the getrlimit/setrlimit interface that can be used to adjust
707process resource usage limits, including the maximum filesize limit.
475d79b5 708
aa855319 709=head2 Long doubles
710
711In some systems you may be able to use long doubles to enhance the
822ba51d 712range and precision of your double precision floating point numbers
aa855319 713(that is, Perl's numbers). Use Configure -Duselongdouble to enable
714this support (if it is available).
715
716=head2 "more bits"
717
822ba51d 718You can "Configure -Dusemorebits" to turn on both the 64-bit support
aa855319 719and the long double support.
09bef843 720
43481408 721=head2 Enhanced support for sort() subroutines
722
723Perl subroutines with a prototype of C<($$)> and XSUBs in general can
724now be used as sort subroutines. In either case, the two elements to
af365420 725be compared are passed as normal parameters in @_. See L<perlfunc/sort>.
43481408 726
727For unprototyped sort subroutines, the historical behavior of passing
728the elements to be compared as the global variables $a and $b remains
729unchanged.
730
62c18ce2 731=head2 Better syntax checks on parenthesized unary operators
732
733Expressions such as:
734
14218588 735 print defined(&foo,&bar,&baz);
736 print uc("foo","bar","baz");
737 undef($foo,&bar);
62c18ce2 738
7711098a 739used to be accidentally allowed in earlier versions, and produced
14218588 740unpredictable behaviour. Some produced ancillary warnings
741when used in this way; others silently did the wrong thing.
62c18ce2 742
743The parenthesized forms of most unary operators that expect a single
14218588 744argument now ensure that they are not called with more than one
745argument, making the cases shown above syntax errors. The usual
746behaviour of:
62c18ce2 747
14218588 748 print defined &foo, &bar, &baz;
749 print uc "foo", "bar", "baz";
750 undef $foo, &bar;
62c18ce2 751
752remains unchanged. See L<perlop>.
753
3e3318e7 754=head2 POSIX character class syntax [: :] supported
755
756For example to match alphabetic characters use /[[:alpha:]]/.
757See L<perlre> for details.
758
5a929a98 759=head2 Improved C<qw//> operator
8127e0e3 760
26ef7447 761The C<qw//> operator is now evaluated at compile time into a true list
762instead of being replaced with a run time call to C<split()>. This
14218588 763removes the confusing misbehaviour of C<qw//> in scalar context, which
764had inherited that behaviour from split().
26ef7447 765
766Thus:
767
768 $foo = ($bar) = qw(a b c); print "$foo|$bar\n";
769
770now correctly prints "3|a", instead of "2|a".
8127e0e3 771
5a929a98 772=head2 pack() format 'Z' supported
773
774The new format type 'Z' is useful for packing and unpacking null-terminated
775strings. See L<perlfunc/"pack">.
776
4d0c1c44 777=head2 pack() format modifier '!' supported
ee3907e2 778
14218588 779The new format type modifier '!' is useful for packing and unpacking
ee3907e2 780native shorts, ints, and longs. See L<perlfunc/"pack">.
781
f29c64d6 782=head2 pack() and unpack() support counted strings
783
a5222a85 784The template character '/' can be used to specify a counted string
f29c64d6 785type to be packed or unpacked. See L<perlfunc/"pack">.
786
a5222a85 787=head2 Comments in pack() templates
788
789The '#' character in a template introduces a comment up to
790end of the line. This facilitates documentation of pack()
791templates.
792
2b92dfce 793=head2 $^X variables may now have names longer than one character
794
795Formerly, $^X was synonymous with ${"\cX"}, but $^XY was a syntax
796error. Now variable names that begin with a control character may be
797arbitrarily long. However, for compatibility reasons, these variables
798I<must> be written with explicit braces, as C<${^XY}> for example.
14218588 799C<${^XYZ}> is synonymous with ${"\cXYZ"}. Variable names with more
2b92dfce 800than one control character, such as C<${^XY^Z}>, are illegal.
801
14218588 802The old syntax has not changed. As before, `^X' may be either a
803literal control-X character or the two-character sequence `caret' plus
804`X'. When braces are omitted, the variable name stops after the
2b92dfce 805control character. Thus C<"$^XYZ"> continues to be synonymous with
7711098a 806C<$^X . "YZ"> as before.
2b92dfce 807
808As before, lexical variables may not have names beginning with control
809characters. As before, variables whose names begin with a control
14218588 810character are always forced to be in package `main'. All such variables
811are reserved for future extensions, except those that begin with
09bef843 812C<^_>, which may be used by user programs and are guaranteed not to
14218588 813acquire special meaning in any future version of Perl.
2b92dfce 814
09bef843 815=head2 C<use attrs> implicit in subroutine attributes
816
817Formerly, if you wanted to mark a subroutine as being a method call or
818as requiring an automatic lock() when it is entered, you had to declare
819that with a C<use attrs> pragma in the body of the subroutine.
16070b82 820That can now be accomplished with declaration syntax, like this:
09bef843 821
0120eecf 822 sub mymethod : locked method ;
09bef843 823 ...
16070b82 824 sub mymethod : locked method {
825 ...
826 }
827
828 sub othermethod :locked :method ;
829 ...
830 sub othermethod :locked :method {
09bef843 831 ...
832 }
833
16070b82 834
835(Note how only the first C<:> is mandatory, and whitespace surrounding
836the C<:> is optional.)
837
09bef843 838F<AutoSplit.pm> and F<SelfLoader.pm> have been updated to keep the attributes
839with the stubs they provide. See L<attributes>.
840
a5222a85 841=head2 Regular expression improvements
842
843change#2827,2373,2372,2365,1813,1800,4112,4158,4215,4301
844[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
845
846=head2 Overloading improvements
847
848change#2150
849[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
850
851=head2 open() with more than two arguments
852
853[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
854
855=head2 Support for interpolating named characters
856
857change#4052
858[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
859
08cd8952 860=head2 Experimental support for user-hooks in @INC
a5222a85 861
862[TODO - Ken Fox <kfox@ford.com>]
863
864=head2 C<require> and C<do> may be overridden
865
866C<require> and C<do 'file'> operations may be overridden locally
867by importing subroutines of the same name into the current package
868(or globally by importing them into the CORE::GLOBAL:: namespace).
869Overriding C<require> will also affect C<use>, provided the override
870is visible at compile-time.
871See L<perlsub/"Overriding Built-in Functions">.
872
873=head2 New variable $^C reflects C<-c> switch
874
08cd8952 875C<$^C> has a boolean value that reflects whether perl is being run
a5222a85 876in compile-only mode (i.e. via the C<-c> switch). Since
877BEGIN blocks are executed under such conditions, this variable
878enables perl code to determine whether actions that make sense
879only during normal running are warranted. See L<perlvar>.
880
16070b82 881=head2 New variable $^V contains Perl version in v5.6.0 format
882
da2094fd 883C<$^V> contains the Perl version number as a string composed of
44dcb63b 884characters whose ordinals match the version numbers, so that it may
885be used in string comparisons.
886
887See C<Support for strings represented as a vector of ordinals> for an
888example.
16070b82 889
a5222a85 890=head2 Optional Y2K warnings
891
892If Perl is built with the cpp macro C<PERL_Y2KWARN> defined,
893it emits optional warnings when concatenating the number 19
894with another number.
895
896This behavior must be specifically enabled when running Configure.
b4bc034f 897See F<INSTALL> and F<README.Y2K>.
a5222a85 898
fbad3eb5 899=head1 Significant bug fixes
900
901=head2 E<lt>HANDLEE<gt> on empty files
902
191f2cf3 903With C<$/> set to C<undef>, "slurping" an empty file returns a string of
14218588 904zero length (instead of C<undef>, as it used to) the first time the
191f2cf3 905HANDLE is read after C<$/> is set to C<undef>. Further reads yield
906C<undef>.
fbad3eb5 907
908This means that the following will append "foo" to an empty file (it used
14218588 909to do nothing):
fbad3eb5 910
911 perl -0777 -pi -e 's/^/foo/' empty_file
912
14218588 913The behaviour of:
fbad3eb5 914
915 perl -pi -e 's/^/foo/' empty_file
916
917is unchanged (it continues to leave the file empty).
918
0244c3a4 919=head2 C<eval '...'> improvements
920
921Line numbers (as reflected by caller() and most diagnostics) within
922C<eval '...'> were often incorrect when here documents were involved.
923This has been corrected.
924
925Lexical lookups for variables appearing in C<eval '...'> within
926functions that were themselves called within an C<eval '...'> were
14218588 927searching the wrong place for lexicals. The lexical search now
928correctly ends at the subroutine's block boundary.
0244c3a4 929
930Parsing of here documents used to be flawed when they appeared as
931the replacement expression in C<eval 's/.../.../e'>. This has
932been fixed.
933
a5222a85 934=head2 All compilation errors are true errors
935
936Some "errors" encountered at compile time were by neccessity
937generated as warnings followed by eventual termination of the
938program. This enabled more such errors to be reported in a
939single run, rather than causing a hard stop at the first error
940that was encountered.
941
942The mechanism for reporting such errors has been reimplemented
943to queue compile-time errors and report them at the end of the
944compilation as true errors rather than as warnings. This fixes
08cd8952 945cases where error messages leaked through in the form of warnings
946when code was compiled at run time using C<eval STRING>, and
947also allows such errors to be reliably trapped using __DIE__ hooks.
a5222a85 948
45bc9206 949=head2 Automatic flushing of output buffers
950
14218588 951fork(), exec(), system(), qx//, and pipe open()s now flush buffers
952of all files opened for output when the operation
953was attempted. This mostly eliminates confusing
45bc9206 954buffering mishaps suffered by users unaware of how Perl internally
14218588 955handles I/O.
45bc9206 956
af8c498a 957=head2 Better diagnostics on meaningless filehandle operations
958
959Constructs such as C<open(E<lt>FHE<gt>)> and C<close(E<lt>FHE<gt>)>
960are compile time errors. Attempting to read from filehandles that
961were opened only for writing will now produce warnings (just as
962writing to read-only filehandles does).
963
a5222a85 964=head2 Where possible, buffered data discarded from duped input filehandle
965
966C<open(NEW, "E<lt>&OLD")> now attempts to discard any data that
967was previously read and buffered in C<OLD> before duping the handle.
968On platforms where doing this is allowed, the next read operation
969on C<NEW> will return the same data as the corresponding operation
970on C<OLD>. Formerly, it would have returned the data from the start
971of the following disk block instead.
972
820475bd 973=head2 eof() has the same old magic as <>
974
975C<eof()> would return true if no attempt to read from C<E<lt>E<gt>> had
976yet been made. C<eof()> has been changed to have a little magic of its
977own, it now opens the C<E<lt>E<gt>> files.
978
a5222a85 979=head2 system(), backticks and pipe open now reflect exec() failure
980
981On Unix and similar platforms, system(), qx() and open(FOO, "cmd |")
982etc., are implemented via fork() and exec(). When the underlying
983exec() fails, earlier versions did not report the error properly,
984since the exec() happened to be in a different process.
985
986The child process now communicates with the parent about the
437784d6 987error in launching the external command, which allows these
a5222a85 988constructs to return with their usual error value and set $!.
989
990=head2 Implicitly closed filehandles are safer
991
992Sometimes implicitly closed filehandles (as when they are localized,
993and Perl automatically closes them on exiting the scope) could
994inadvertently set $? or $!. This has been corrected.
995
996=head2 C<(\$)> prototype and C<$foo{a}>
997
998An scalar reference prototype now correctly allows a hash or
999array element in that slot.
1000
1001=head2 Pseudo-hashes work better
1002
1003Dereferencing some types of reference values in a pseudo-hash,
f91101c9 1004such as C<$ph-E<gt>{foo}[1]>, was accidentally disallowed. This has
a5222a85 1005been corrected.
1006
1007When applied to a pseudo-hash element, exists() now reports whether
1008the specified value exists, not merely if the key is valid.
1009
01020589 1010delete() now works on pseudo-hashes. When given a pseudo-hash element
1011or slice it deletes the values corresponding to the keys (but not the keys
1012themselves). See L<perlref/"Pseudo-hashes: Using an array as a hash">.
1013
a5222a85 1014=head2 C<goto &sub> and AUTOLOAD
1015
08cd8952 1016The C<goto &sub> construct works correctly when C<&sub> happens
a5222a85 1017to be autoloaded.
1018
1019=head2 C<-bareword> allowed under C<use integer>
1020
1021The autoquoting of barewords preceded by C<-> did not work
1022in prior versions when the C<integer> pragma was enabled.
1023This has been fixed.
1024
1025=head2 Boolean assignment operators are legal lvalues
1026
1027Constructs such as C<($a ||= 2) += 1> are now allowed.
1028
1029=head2 C<sort $coderef @foo> allowed
1030
1031sort() did not accept a subroutine reference as the comparison
08cd8952 1032function in earlier versions. This is now permitted.
a5222a85 1033
1034=head2 Failures in DESTROY()
1035
1036When code in a destructor threw an exception, it went unnoticed
1037in earlier versions of Perl, unless someone happened to be
1038looking in $@ just after the point the destructor happened to
1039run. Such failures are now visible as warnings when warnings are
1040enabled.
1041
1042=head2 Locale bugs fixed
54195c32 1043
437784d6 1044printf() and sprintf() previously reset the numeric locale
67d3893f 1045back to the default "C" locale. This has been fixed.
1046
1047Numbers formatted according to the local numeric locale
1048(such as using a decimal comma instead of a decimal dot) caused
1049"isn't numeric" warnings, even while the operations accessing
1050those numbers produced correct results. The warnings are gone.
54195c32 1051
a5222a85 1052=head2 Memory leaks
1053
1054The C<eval 'return sub {...}'> construct could sometimes leak
1055memory. This has been fixed.
1056
1057Operations that aren't filehandle constructors used to leak memory
1058when used on invalid filehandles. This has been fixed.
1059
1060Constructs that modified C<@_> could fail to deallocate values
1061in C<@_> and thus leak memory. This has been corrected.
1062
1063=head2 Spurious subroutine stubs after failed subroutine calls
1064
1065Perl could sometimes create empty subroutine stubs when a
1066subroutine was not found in the package. Such cases stopped
1067later method lookups from progressing into base packages.
1068This has been corrected.
1069
1070=head2 Consistent numeric conversions
1071
1072change#3378,3318
1073[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1074
1075=head2 Taint failures under C<-U>
1076
1077When running in unsafe mode, taint violations could sometimes
1078cause silent failures. This has been fixed.
1079
1080=head2 END blocks and the C<-c> switch
1081
1082Prior versions used to run BEGIN B<and> END blocks when Perl was
1083run in compile-only mode. Since this is typically not the expected
08cd8952 1084behavior, END blocks are not executed anymore when the C<-c> switch
a5222a85 1085is used.
1086
7d30b5c4 1087See L<CHECK blocks> for how to run things when the compile phase ends.
a5222a85 1088
1089=head2 Potential to leak DATA filehandles
1090
1091Using the C<__DATA__> token creates an implicit filehandle to
1092the file that contains the token. It is the program's
1093responsibility to close it when it is done reading from it.
1094
1095This caveat is now better explained in the documentation.
1096See L<perldata>.
1097
1098=head2 Diagnostics follow STDERR
1099
1100Diagnostic output now goes to whichever file the C<STDERR> handle
1101is pointing at, instead of always going to the underlying C runtime
1102library's C<stderr>.
1103
1104=head2 Other fixes for better diagnostics
1105
437784d6 1106Line numbers are no longer suppressed (under most likely circumstances)
a5222a85 1107during the global destruction phase.
1108
1109Diagnostics emitted from code running in threads other than the main
1110thread are now accompanied by the thread ID.
1111
1112Embedded null characters in diagnostics now actually show up. They
1113used to truncate the message in prior versions.
1114
1115$foo::a and $foo::b are now exempt from "possible typo" warnings only
1116if sort() is encountered in package foo.
1117
501fbaef 1118Unrecognized alphabetic escapes encountered when parsing quote
a5222a85 1119constructs now generate a warning, since they may take on new
1120semantics in later versions of Perl.
1121
1122=head1 Performance enhancements
1123
1124=head2 Simple sort() using { $a <=> $b } and the like are optimized
1125
08cd8952 1126Many common sort() operations using a simple inlined block are now
a5222a85 1127optimized for faster performance.
1128
1129=head2 Optimized assignments to lexical variables
1130
1131Certain operations in the RHS of assignment statements have been
1132optimized to directly set the lexical variable on the LHS,
1133eliminating redundant copying overheads.
1134
1135=head2 Method lookups optimized
1136
1137[TODO - Chip Salzenberg <chip@perlsupport.com>]
1138
1139=head2 Faster mechanism to invoke XSUBs
1140
1141change#4044,4125
1142[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1143
1144=head2 Perl_malloc() improvements
1145
1146change#4237
1147[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1148
1149=head2 Faster subroutine calls
1150
1151Minor changes in how subroutine calls are handled internally
1152provide marginal improvements in performance.
1153
1154=head1 Platform specific changes
1155
1156=head2 Additional supported platforms
ba8251e8 1157
5fdc711f 1158=over 4
1159
1160=item *
1161
6c67e1bb 1162VM/ESA is now supported.
1163
5fdc711f 1164=item *
1165
ee3907e2 1166Siemens BS2000 is now supported under the POSIX Shell.
1167
1168=item *
1169
2bb14304 1170The Mach CThreads (NEXTSTEP, OPENSTEP) are now supported by the Thread
1171extension.
6c67e1bb 1172
5fdc711f 1173=item *
1174
ee3907e2 1175GNU/Hurd is now supported.
6c67e1bb 1176
00ad96e1 1177=item *
1178
1179Rhapsody is now supported.
1180
27806c82 1181=item *
1182
1183EPOC is is now supported (on Psion 5).
1184
5fdc711f 1185=back
1186
a5222a85 1187=head2 DOS
1188
d524f05e 1189=over 4
1190
1191=item *
1192
1193Perl now works with djgpp 2.02 (and 2.03 alpha).
1194
1195=item *
1196
1197Environment variable names are not converted to uppercase any more.
1198
1199=item *
1200
1201Wrong exit code from backticks now fixed.
1202
1203=item *
1204
1205This port is still using its own builtin globbing.
1206
1207=back
a5222a85 1208
1209=head2 OS/2
1210
1211[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1212
1213=head2 VMS
1214
1215[TODO - Charles Bailey <bailey@newman.upenn.edu>]
1216
1217=head2 Win32
1218
1219Site library searches failed to look for ".../site/5.XXX/lib"
1220if ".../site/5.XXXYY/lib" wasn't found. This has been corrected.
1221
1222When given a pathname that consists only of a drivename, such
1223as C<A:>, opendir() and stat() now use the current working
1224directory for the drive rather than the drive root.
1225
1226The builtin XSUB functions in the Win32:: namespace are
1227documented. See L<Win32>.
1228
1229$^X now contains the full path name of the running executable.
1230
1231A Win32::GetLongPathName() function is provided to complement
1232Win32::GetFullPathName() and Win32::GetShortPathName(). See L<Win32>.
1233
1234POSIX::uname() is supported.
1235
1236system(1,...) now returns true process IDs rather than process
1237handles. kill() accepts any real process id, rather than strictly
1238return values from system(1,...).
1239
1240The C<Shell> module is supported.
1241
883d36a6 1242Rudimentary support for building under command.com in Windows 95
1243has been added.
1244
c39cd008 1245Scripts are read in binary mode by default to allow ByteLoader (and
1246the filter mechanism in general) to work properly. For compatibility,
53129d29 1247the DATA filehandle will be set to text mode if a carriage return is
1248detected at the end of the line containing the __END__ or __DATA__
1249token; if not, the DATA filehandle will be left open in binary mode.
1250Earlier versions always opened the DATA filehandle in text mode.
c39cd008 1251
16070b82 1252The glob() operator is implemented via the L<File::Glob> extension,
8004f2ac 1253which supports glob syntax of the C shell. This increases the flexibility
16070b82 1254of the glob() operator, but there may be compatibility issues for
1255programs that relied on the older globbing syntax. If you want to
1256preserve compatibility with the older syntax, you might want to put
1257a C<use File::DosGlob;> in your program. For details and compatibility
1258information, see L<File::Glob>.
1259
a5222a85 1260[TODO - GSAR]
1261
6c67e1bb 1262=head1 New tests
1263
1264=over 4
1265
09bef843 1266=item lib/attrs
1267
1268Compatibility tests for C<sub : attrs> vs the older C<use attrs>.
1269
1270=item lib/io_const
6c67e1bb 1271
1272IO constants (SEEK_*, _IO*).
14218588 1273
09bef843 1274=item lib/io_dir
6c67e1bb 1275
1276Directory-related IO methods (new, read, close, rewind, tied delete).
1277
09bef843 1278=item lib/io_multihomed
6c67e1bb 1279
1280INET sockets with multi-homed hosts.
1281
09bef843 1282=item lib/io_poll
6c67e1bb 1283
1284IO poll().
1285
09bef843 1286=item lib/io_unix
6c67e1bb 1287
1288UNIX sockets.
1289
09bef843 1290=item op/attrs
1291
1292Regression tests for C<my ($x,@y,%z) : attrs> and <sub : attrs>.
1293
6c67e1bb 1294=item op/filetest
1295
1296File test operators.
1297
1298=item op/lex_assign
1299
5fdc711f 1300Verify operations that access pad objects (lexicals and temporaries).
6c67e1bb 1301
afebc493 1302=item op/exists_sub
1303
1304Verify C<exists &sub> operations.
1305
6c67e1bb 1306=back
e02fdbd2 1307
ba8251e8 1308=head1 Modules and Pragmata
1309
3e8c4fa0 1310=head2 Modules
1311
b7d8191e 1312=over 4
1313
09bef843 1314=item attributes
1315
1316While used internally by Perl as a pragma, this module also
1317provides a way to fetch subroutine and variable attributes.
1318See L<attributes>.
1319
a5222a85 1320=item B
1321
501fbaef 1322The Perl Compiler suite has been extensively reworked for this
1323release.
1324
a5222a85 1325[TODO - Vishal Bhatia <vishal@gol.com>,
1326Nick Ing-Simmons <nick@ni-s.u-net.com>]
1327
f29c64d6 1328=item ByteLoader
1329
a5222a85 1330The ByteLoader is a dedicated extension to generate and run
f29c64d6 1331Perl bytecode. See L<ByteLoader>.
1332
a5222a85 1333=item constant
1334
83763826 1335References can now be used.
1336
1337The new version also allows a leading underscore in constant names, but
1338disallows a double leading underscore (as in "__LINE__"). Some other names
1339are disallowed or warned against, including BEGIN, END, etc. Some names
1340which were forced into main:: used to fail silently in some cases; now they're
1341fatal (outside of main::) and an optional warning (inside of main::).
1342The ability to detect whether a constant had been set with a given name has
1343been added.
1344
1345See L<constant>.
a5222a85 1346
1347=item charnames
1348
1349change#4052
1350[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1351
1352=item Data::Dumper
1353
1354A C<Maxdepth> setting can be specified to avoid venturing
73b437c8 1355too deeply into deep data structures. See L<Data::Dumper>.
a5222a85 1356
1357Dumping C<qr//> objects works correctly.
1358
1359=item DB
1360
1361C<DB> is an experimental module that exposes a clean abstraction
1362to Perl's debugging API.
1363
1364=item DB_File
1365
0536e0eb 1366DB_File can now be built with Berkeley DB versions 1, 2 or 3.
1367See C<ext/DB_File/Changes>.
a5222a85 1368
f29c64d6 1369=item Devel::DProf
1370
9e107c59 1371Devel::DProf, a Perl source code profiler has been added. See
1372L<Devel::DProf> and L<dprofpp>.
f29c64d6 1373
b7d8191e 1374=item Dumpvalue
1375
437784d6 1376The Dumpvalue module provides screen dumps of Perl data.
b7d8191e 1377
1378=item Benchmark
1379
54e82ce5 1380Overall, Benchmark results exhibit lower average error and better timing
1381accuracy.
1382
868cb350 1383You can now run tests for I<n> seconds instead of guessing the right
14218588 1384number of tests to run: e.g. timethese(-5, ...) will run each
1385code for at least 5 CPU seconds. Zero as the "number of repetitions"
155776c0 1386means "for at least 3 CPU seconds". The output format has also
14218588 1387changed. For example:
155776c0 1388
54e82ce5 1389 use Benchmark;$x=3;timethese(-5,{a=>sub{$x*$x},b=>sub{$x**2}})
155776c0 1390
1391will now output something like this:
1392
54e82ce5 1393 Benchmark: running a, b, each for at least 5 CPU seconds...
1394 a: 5 wallclock secs ( 5.77 usr + 0.00 sys = 5.77 CPU) @ 200551.91/s (n=1156516)
1395 b: 4 wallclock secs ( 5.00 usr + 0.02 sys = 5.02 CPU) @ 159605.18/s (n=800686)
155776c0 1396
1397New features: "each for at least N CPU seconds...", "wallclock secs",
1398and the "@ operations/CPU second (n=operations)".
b7d8191e 1399
54e82ce5 1400timethese() now returns a reference to a hash of Benchmark objects containing
1401the test results, keyed on the names of the tests.
1402
1403timethis() now returns the iterations field in the Benchmark result object
1404instead of 0.
1405
1406timethese(), timethis(), and the new cmpthese() (see below) can also take
1407a format specifier of 'none' to suppress output.
1408
1409A new function countit() is just like timeit() except that it takes a
1410TIME instead of a COUNT.
1411
1412A new function cmpthese() prints a chart comparing the results of each test
1413returned from a timethese() call. For each possible pair of tests, the
1414percentage speed difference (iters/sec or seconds/iter) is shown.
1415
1416For other details, see L<Benchmark>.
a5222a85 1417
f505c983 1418=item Devel::Peek
1419
1420The Devel::Peek module provides access to the internal representation
14218588 1421of Perl variables and data. It is a data debugging tool for the XS programmer.
f505c983 1422
44dcb63b 1423=item English
1424
1425$PERL_VERSION now stands for C<$^V> (a string value) rather than for C<$]>
1426(a numeric value).
1427
a5222a85 1428=item ExtUtils::MakeMaker
1429
1430change#4135, also needs docs in module pod
1431[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
1432
b7d8191e 1433=item Fcntl
1434
1435More Fcntl constants added: F_SETLK64, F_SETLKW64, O_LARGEFILE for
822ba51d 1436large file (more than 4GB) access Note that the O_LARGEFILE is
1437automatically/transparently added to sysopen() flags if large file
1438support has been configured), Free/Net/OpenBSD locking behaviour flags
1439F_FLOCK, F_POSIX, Linux F_SHLCK, and O_ACCMODE: the combined mask of
ca6e1c26 1440O_RDONLY, O_WRONLY, and O_RDWR. The seek()/sysseek() constants
1441SEEK_SET, SEEK_CUR, and SEEK_END are available via the C<:seek> tag.
1442The chmod()/stat() S_IF* constants and S_IS* functions are available
1443via the C<:mode> tag.
1444
b7d8191e 1445
a5222a85 1446=item File::Compare
1447
1448A compare_text() function has been added, which allows custom
1449comparison functions. See L<File::Compare>.
1450
1451=item File::Find
1452
1453File::Find now works correctly when the wanted() function is either
1454autoloaded or is a symbolic reference.
1455
08cd8952 1456A bug that caused File::Find to lose track of the working directory
a5222a85 1457when pruning top-level directories has been fixed.
1458
81793b90 1459File::Find now also supports several other options to control its
1460behavior. It can follow symbolic links if the C<follow> option is
1461specified. Enabling the C<no_chdir> option will make File::Find skip
1462changing the current directory when walking directories. The C<untaint>
1463flag can be useful when running with taint checks enabled.
1464
1465See L<File::Find>.
1466
becf2bd3 1467=item File::Glob
1468
52bb0670 1469This extension implements BSD-style file globbing. By default,
1470it will also be used for the internal implementation of the glob()
1471operator. See L<File::Glob>.
becf2bd3 1472
f505c983 1473=item File::Spec
1474
1475New methods have been added to the File::Spec module: devnull() returns
19799a22 1476the name of the null device (/dev/null on Unix) and tmpdir() the name of
14218588 1477the temp directory (normally /tmp on Unix). There are now also methods
f505c983 1478to convert between absolute and relative filenames: abs2rel() and
14218588 1479rel2abs(). For compatibility with operating systems that specify volume
1480names in file paths, the splitpath(), splitdir(), and catdir() methods
f505c983 1481have been added.
1482
1483=item File::Spec::Functions
1484
1485The new File::Spec::Functions modules provides a function interface
14218588 1486to the File::Spec module. Allows shorthand
f505c983 1487
14218588 1488 $fullname = catfile($dir1, $dir2, $file);
f505c983 1489
1490instead of
1491
14218588 1492 $fullname = File::Spec->catfile($dir1, $dir2, $file);
f505c983 1493
a5222a85 1494=item Getopt::Long
1495
c6edd1b7 1496Getopt::Long licensing has changed to allow the Perl Artistic License
1497as well as the GPL. It used to be GPL only, which got in the way of
1498non-GPL applications that wanted to use Getopt::Long.
1499
1500Getopt::Long encourages the use of Pod::Usage to produce help
1501messages. For example:
1502
1503 use Getopt::Long;
1504 use Pod::Usage;
1505 my $man = 0;
1506 my $help = 0;
1507 GetOptions('help|?' => \$help, man => \$man) or pod2usage(2);
1508 pod2usage(1) if $help;
1509 pod2usage(-exitstatus => 0, -verbose => 2) if $man;
1510
1511 __END__
1512
1513 =head1 NAME
1514
1515 sample - Using GetOpt::Long and Pod::Usage
1516
1517 =head1 SYNOPSIS
1518
1519 sample [options] [file ...]
1520
1521 Options:
1522 -help brief help message
1523 -man full documentation
1524
1525 =head1 OPTIONS
1526
1527 =over 8
1528
1529 =item B<-help>
1530
1531 Print a brief help message and exits.
1532
1533 =item B<-man>
1534
1535 Prints the manual page and exits.
1536
1537 =back
1538
1539 =head1 DESCRIPTION
1540
1541 B<This program> will read the given input file(s) and do someting
1542 useful with the contents thereof.
1543
1544 =cut
1545
1546See L<Pod::Usage> for details.
1547
1548A bug that prevented the non-option call-back E<lt>E<gt> from being
1549specified as the first argument has been fixed.
1550
1551To specify the characters E<lt> and E<gt> as option starters, use
1552E<gt>E<lt>. Note, however, that changing option starters is strongly
1553deprecated.
a5222a85 1554
1555=item IO
1556
1557write() and syswrite() will now accept a single-argument
1558form of the call, for consistency with Perl's syswrite().
1559
1560You can now create a TCP-based IO::Socket::INET without forcing
1561a connect attempt. This allows you to configure its options
1562(like making it non-blocking) and then call connect() manually.
1563
1564A bug that prevented the IO::Socket::protocol() accessor
1565from ever returning the correct value has been corrected.
1566
1567=item JPL
1568
1569Java Perl Lingo is now distributed with Perl. See jpl/README
1570for more information.
1571
883d36a6 1572=item lib
1573
1574C<use lib> now weeds out any trailing duplicate entries.
1575C<no lib> removes all named entries.
1576
e16b8f49 1577=item Math::BigInt
1578
437784d6 1579The bitwise operations C<E<lt>E<lt>>, C<E<gt>E<gt>>, C<&>, C<|>,
e16b8f49 1580and C<~> are now supported on bigints.
1581
b7d8191e 1582=item Math::Complex
7711098a 1583
14218588 1584The accessor methods Re, Im, arg, abs, rho, and theta can now also
868cb350 1585act as mutators (accessor $z->Re(), mutator $z->Re(3)).
b7d8191e 1586
1587=item Math::Trig
1588
14218588 1589A little bit of radial trigonometry (cylindrical and spherical),
1590radial coordinate conversions, and the great circle distance were added.
b7d8191e 1591
1761cee5 1592=item Pod::Parser, Pod::InputObjects
d4629d6a 1593
1761cee5 1594Pod::Parser is a base class for parsing and selecting sections of
1595pod documentation from an input stream. This module takes care of
1596identifying pod paragraphs and commands in the input and hands off the
1597parsed paragraphs and commands to user-defined methods which are free
1598to interpret or translate them as they see fit.
d4629d6a 1599
1600Pod::InputObjects defines some input objects needed by Pod::Parser, and
1601for advanced users of Pod::Parser that need more about a command besides
1761cee5 1602its name and text.
d4629d6a 1603
1604As of release 5.6 of Perl, Pod::Parser is now the officially sanctioned
1605"base parser code" recommended for use by all pod2xxx translators.
1606Pod::Text (pod2text) and Pod::Man (pod2man) have already been converted
1761cee5 1607to use Pod::Parser and efforts to convert Pod::HTML (pod2html) are already
1608underway. For any questions or comments about pod parsing and translating
1609issues and utilities, please use the pod-people@perl.org mailing list.
d4629d6a 1610
1761cee5 1611For further information, please see L<Pod::Parser> and L<Pod::InputObjects>.
d4629d6a 1612
1761cee5 1613=item Pod::Checker, podchecker
d4629d6a 1614
1761cee5 1615This utility checks pod files for correct syntax, according to
1616L<perlpod>. Obvious errors are flagged as such, while warnings are
1617printed for mistakes that can be handled gracefully. The checklist is
1618not complete yet. See L<Pod::Checker>.
d4629d6a 1619
1761cee5 1620=item Pod::ParseUtils, Pod::Find
d4629d6a 1621
1761cee5 1622These modules provide a set of gizmos that are useful mainly for pod
1623translators. L<Pod::Find|Pod::Find> traverses directory structures and
1624returns found pod files, along with their canonical names (like
1625C<File::Spec::Unix>). L<Pod::ParseUtils|Pod::ParseUtils> contains
1626B<Pod::List> (useful for storing pod list information), B<Pod::Hyperlink>
1627(for parsing the contents of C<LE<gt>E<lt>> sequences) and B<Pod::Cache>
1628(for caching information about pod files, e.g. link nodes).
d4629d6a 1629
1761cee5 1630=item Pod::Select, podselect
d4629d6a 1631
1761cee5 1632Pod::Select is a subclass of Pod::Parser which provides a function
1633named "podselect()" to filter out user-specified sections of raw pod
1634documentation from an input stream. podselect is a script that provides
1635access to Pod::Select from other scripts to be used as a filter.
1636See L<Pod::Select>.
d4629d6a 1637
1761cee5 1638=item Pod::Usage, pod2usage
d4629d6a 1639
1761cee5 1640Pod::Usage provides the function "pod2usage()" to print usage messages for
1641a Perl script based on its embedded pod documentation. The pod2usage()
1642function is generally useful to all script authors since it lets them
1643write and maintain a single source (the pods) for documentation, thus
1644removing the need to create and maintain redundant usage message text
1645consisting of information already in the pods.
d4629d6a 1646
1761cee5 1647There is also a pod2usage script which can be used from other kinds of
1648scripts to print usage messages from pods (even for non-Perl scripts
1649with pods embedded in comments).
a5222a85 1650
1761cee5 1651For details and examples, please see L<Pod::Usage>.
a5222a85 1652
1653=item Pod::Text and Pod::Man
1654
1655[TODO - Russ Allbery <rra@stanford.edu>]
1656
f4b9d880 1657=item SDBM_File
1658
1659An EXISTS method has been added to this module (and sdbm_exists() has
1660been added to the underlying sdbm library), so one can now call exists
14218588 1661on an SDBM_File tied hash and get the correct result, rather than a
f4b9d880 1662runtime error.
1663
a5222a85 1664A bug that may have caused data loss when more than one disk block
1665happens to be read from the database in a single FETCH() has been
1666fixed.
1667
8ce86de8 1668=item Sys::Syslog
1669
1670Sys::Syslog now uses XSUBs to access facilities from syslog.h so it
1671no longer requires syslog.ph to exist.
1672
f91101c9 1673=item Sys::Hostname
1674
1675Sys::Hostname now uses XSUBs to call the C library's gethostname() or
1676uname() if they exist.
1677
06ef4121 1678=item Time::Local
1679
1680The timelocal() and timegm() functions used to silently return bogus
437784d6 1681results when the date fell outside the machine's integer range. They
a5222a85 1682now consistently croak() if the date falls in an unsupported range.
06ef4121 1683
8fe0a5c4 1684=item Win32
1685
1686The error return value in list context has been changed for all functions
14218588 1687that return a list of values. Previously these functions returned a list
1688with a single element C<undef> if an error occurred. Now these functions
1689return the empty list in these situations. This applies to the following
8fe0a5c4 1690functions:
1691
14218588 1692 Win32::FsType
1693 Win32::GetOSVersion
8fe0a5c4 1694
1695The remaining functions are unchanged and continue to return C<undef> on
1696error even in list context.
1697
1698The Win32::SetLastError(ERROR) function has been added as a complement
1699to the Win32::GetLastError() function.
1700
1701The new Win32::GetFullPathName(FILENAME) returns the full absolute
14218588 1702pathname for FILENAME in scalar context. In list context it returns
1703a two-element list containing the fully qualified directory name and
501fbaef 1704the filename. See L<Win32>.
8fe0a5c4 1705
9fe6733a 1706=item DBM Filters
1707
1708A new feature called "DBM Filters" has been added to all the
14218588 1709DBM modules--DB_File, GDBM_File, NDBM_File, ODBM_File, and SDBM_File.
1710DBM Filters add four new methods to each DBM module:
9fe6733a 1711
1712 filter_store_key
1713 filter_store_value
1714 filter_fetch_key
1715 filter_fetch_value
1716
14218588 1717These can be used to filter key-value pairs before the pairs are
9fe6733a 1718written to the database or just after they are read from the database.
1719See L<perldbmfilter> for further information.
1720
b7d8191e 1721=back
3e8c4fa0 1722
1723=head2 Pragmata
1724
437784d6 1725C<use attrs> is now obsolete, and is only provided for
09bef843 1726backward-compatibility. It's been replaced by the C<sub : attributes>
1727syntax. See L<perlsub/"Subroutine Attributes"> and L<attributes>.
1728
14218588 1729C<use utf8> to enable UTF-8 and Unicode support.
43165c05 1730
4438c4b7 1731Lexical warnings pragma, C<use warnings;>, to control optional warnings.
a5222a85 1732See L<perllexwarn>.
6c67e1bb 1733
67d3893f 1734C<use filetest> to control the behaviour of filetests (C<-r> C<-w>
1735...). Currently only one subpragma implemented, "use filetest
1736'access';", that uses access(2) or equivalent to check permissions
1737instead of using stat(2) as usual. This matters in filesystems
1738where there are ACLs (access control lists): the stat(2) might lie,
1739but access(2) knows better.
6c67e1bb 1740
ba8251e8 1741=head1 Utility Changes
1742
a5222a85 1743=head2 h2ph
1744
1745[TODO - Kurt Starsinic <kstar@chapin.edu>]
1746
1747=head2 perlcc
1748
1749C<perlcc> now supports the C and Bytecode backends. By default,
1750it generates output from the simple C backend rather than the
1751optimized C backend.
1752
1753Support for non-Unix platforms has been improved.
1754
1755=head2 h2xs
1756
1757change#4232
1758[TODO - Ilya Zakharevich <ilya@math.ohio-state.edu>]
e02fdbd2 1759
ba8251e8 1760=head1 Documentation Changes
1761
5fdc711f 1762=over 4
1763
954c1994 1764=item perlapi.pod
1765
1766The official list of public Perl API functions.
1767
883d36a6 1768=item perlcompile.pod
1769
1770An introduction to using the Perl Compiler suite.
1771
c7c04614 1772=item perlfilter.pod
1773
1774An introduction to writing Perl source filters.
1775
883d36a6 1776=item perlhack.pod
1777
1778Some guidelines for hacking the Perl source code.
1779
954c1994 1780=item perlintern.pod
1781
1782A list of internal functions in the Perl source code.
1783(List is currently empty.)
1784
5fdc711f 1785=item perlopentut.pod
f8284313 1786
5fdc711f 1787A tutorial on using open() effectively.
1788
1789=item perlreftut.pod
1790
1791A tutorial that introduces the essentials of references.
1792
14218588 1793=item perltootc.pod
1794
1795A tutorial on managing class data for object modules.
1796
393fec97 1797=item perlunicode.pod
1798
1799An introduction to Unicode support features in Perl.
1800
5fdc711f 1801=back
e02fdbd2 1802
73b437c8 1803=head1 New or Changed Diagnostics
ba8251e8 1804
a99ba403 1805=over 4
1806
56e90b21 1807=item "%s" variable %s masks earlier declaration in same %s
1808
1809(W) A "my" or "our" variable has been redeclared in the current scope or statement,
1810effectively eliminating all access to the previous instance. This is almost
1811always a typographical error. Note that the earlier variable will still exist
1812until the end of the scope or until all closure referents to it are
1813destroyed.
1814
33633739 1815=item "my sub" not yet implemented
1816
1817(F) Lexically scoped subroutines are not yet implemented. Don't try that
1818yet.
1819
1820=item "our" variable %s redeclared
1821
1822(W) You seem to have already declared the same global once before in the
1823current lexical scope.
1824
a99ba403 1825=item '!' allowed only after types %s
1826
1827(F) The '!' is allowed in pack() and unpack() only after certain types.
1828See L<perlfunc/pack>.
1829
1830=item / cannot take a count
1831
1832(F) You had an unpack template indicating a counted-length string,
1833but you have also specified an explicit size for the string.
1834See L<perlfunc/pack>.
1835
1836=item / must be followed by a, A or Z
1837
1838(F) You had an unpack template indicating a counted-length string,
1839which must be followed by one of the letters a, A or Z
1840to indicate what sort of string is to be unpacked.
1841See L<perlfunc/pack>.
1842
1843=item / must be followed by a*, A* or Z*
1844
437784d6 1845(F) You had a pack template indicating a counted-length string,
a99ba403 1846Currently the only things that can have their length counted are a*, A* or Z*.
1847See L<perlfunc/pack>.
1848
1849=item / must follow a numeric type
1850
1851(F) You had an unpack template that contained a '#',
1852but this did not follow some numeric unpack specification.
1853See L<perlfunc/pack>.
1854
a99ba403 1855=item /%s/: Unrecognized escape \\%c passed through
1856
1857(W) You used a backslash-character combination which is not recognized
1858by Perl. This combination appears in an interpolated variable or a
1028017a 1859C<'>-delimited regular expression. The character was understood literally.
1860
1861=item /%s/: Unrecognized escape \\%c in character class passed through
1862
1863(W) You used a backslash-character combination which is not recognized
1864by Perl inside character classes. The character was understood literally.
a99ba403 1865
1866=item /%s/ should probably be written as "%s"
1867
1868(W) You have used a pattern where Perl expected to find a string,
437784d6 1869as in the first argument to C<join>. Perl will treat the true
a99ba403 1870or false result of matching the pattern against $_ as the string,
1871which is probably not what you had in mind.
1872
1873=item %s() called too early to check prototype
1874
1875(W) You've called a function that has a prototype before the parser saw a
1876definition or declaration for it, and Perl could not check that the call
1877conforms to the prototype. You need to either add an early prototype
1878declaration for the subroutine in question, or move the subroutine
1879definition ahead of the call to get proper prototype checking. Alternatively,
1880if you are certain that you're calling the function correctly, you may put
1881an ampersand before the name to avoid the warning. See L<perlsub>.
1882
56e90b21 1883=item %s argument is not a HASH or ARRAY element
1884
1885(F) The argument to exists() must be a hash or array element, such as:
1886
1887 $foo{$bar}
1888 $ref->[12]->["susie"]
1889
1890=item %s argument is not a HASH or ARRAY element or slice
1891
1892(F) The argument to delete() must be either a hash or array element, such as:
1893
1894 $foo{$bar}
1895 $ref->[12]->["susie"]
1896
1897or a hash or array slice, such as:
1898
1899 @foo[$bar, $baz, $xyzzy]
1900 @{$ref->[12]}{"susie", "queue"}
1901
afebc493 1902=item %s argument is not a subroutine name
1903
1904(F) The argument to exists() for C<exists &sub> must be a subroutine
1905name, and not a subroutine call. C<exists &sub()> will generate this error.
1906
09bef843 1907=item %s package attribute may clash with future reserved word: %s
1908
1909(W) A lowercase attribute name was used that had a package-specific handler.
1910That name might have a meaning to Perl itself some day, even though it
1911doesn't yet. Perhaps you should use a mixed-case attribute name, instead.
1912See L<attributes>.
1913
a99ba403 1914=item (in cleanup) %s
6b121555 1915
a99ba403 1916(W) This prefix usually indicates that a DESTROY() method raised
1917the indicated exception. Since destructors are usually called by
1918the system at arbitrary points during execution, and often a vast
1919number of times, the warning is issued only once for any number
1920of failures that would otherwise result in the same message being
1921repeated.
1922
1923Failure of user callbacks dispatched using the C<G_KEEPERR> flag
1924could also result in this warning. See L<perlcall/G_KEEPERR>.
1925
1926=item <> should be quotes
1927
1928(F) You wrote C<require E<lt>fileE<gt>> when you should have written
1929C<require 'file'>.
1930
1931=item Attempt to join self
1932
1933(F) You tried to join a thread from within itself, which is an
1934impossible task. You may be joining the wrong thread, or you may
1935need to move the join() to some other thread.
1936
1937=item Bad evalled substitution pattern
1938
1939(F) You've used the /e switch to evaluate the replacement for a
1940substitution, but perl found a syntax error in the code to evaluate,
1941most likely an unexpected right brace '}'.
1942
1943=item Bad realloc() ignored
1944
1945(S) An internal routine called realloc() on something that had never been
1946malloc()ed in the first place. Mandatory, but can be disabled by
1947setting environment variable C<PERL_BADFREE> to 1.
1948
34d09196 1949=item Bareword found in conditional
1950
1951(W) The compiler found a bareword where it expected a conditional,
1952which often indicates that an || or && was parsed as part of the
1953last argument of the previous construct, for example:
1954
1955 open FOO || die;
1956
1957It may also indicate a misspelled constant that has been interpreted
1958as a bareword:
1959
1960 use constant TYPO => 1;
1961 if (TYOP) { print "foo" }
1962
1963The C<strict> pragma is useful in avoiding such errors.
1964
a99ba403 1965=item Binary number > 0b11111111111111111111111111111111 non-portable
1966
1967(W) The binary number you specified is larger than 2**32-1
1968(4294967295) and therefore non-portable between systems. See
1969L<perlport> for more on portability concerns.
1970
1971=item Bit vector size > 32 non-portable
1972
1973(W) Using bit vector sizes larger than 32 is non-portable.
1974
1975=item Buffer overflow in prime_env_iter: %s
1976
1977(W) A warning peculiar to VMS. While Perl was preparing to iterate over
1978%ENV, it encountered a logical name or symbol definition which was too long,
1979so it was truncated to the string shown.
1980
1981=item Can't check filesystem of script "%s"
1982
1983(P) For some reason you can't check the filesystem of the script for nosuid.
1984
56e90b21 1985=item Can't declare class for non-scalar %s in "%s"
1986
1987(S) Currently, only scalar variables can declared with a specific class
1988qualifier in a "my" or "our" declaration. The semantics may be extended
1989for other types of variables in future.
1990
1991=item Can't declare %s in "%s"
1992
1993(F) Only scalar, array, and hash variables may be declared as "my" or
1994"our" variables. They must have ordinary identifiers as names.
1995
0b5b802d 1996=item Can't ignore signal CHLD, forcing to default
1997
1998(W) Perl has detected that it is being run with the SIGCHLD signal
1999(sometimes known as SIGCLD) disabled. Since disabling this signal
2000will interfere with proper determination of exit status of child
2001processes, Perl has reset the signal to its default value.
2002This situation typically indicates that the parent program under
2003which Perl may be running (e.g. cron) is being very careless.
2004
a99ba403 2005=item Can't modify non-lvalue subroutine call
2006
437784d6 2007(F) Subroutines meant to be used in lvalue context should be declared as
2008such, see L<perlsub/"Lvalue subroutines">.
a99ba403 2009
2010=item Can't read CRTL environ
2011
2012(S) A warning peculiar to VMS. Perl tried to read an element of %ENV
2013from the CRTL's internal environment array and discovered the array was
2014missing. You need to figure out where your CRTL misplaced its environ
2015or define F<PERL_ENV_TABLES> (see L<perlvms>) so that environ is not searched.
2016
2017=item Can't remove %s: %s, skipping file
2018
2019(S) You requested an inplace edit without creating a backup file. Perl
2020was unable to remove the original file to replace it with the modified
2021file. The file was left unmodified.
2022
2023=item Can't return %s from lvalue subroutine
2024
2025(F) Perl detected an attempt to return illegal lvalues (such
2026as temporary or readonly values) from a subroutine used as an lvalue.
2027This is not allowed.
2028
2029=item Can't weaken a nonreference
2030
2031(F) You attempted to weaken something that was not a reference. Only
2032references can be weakened.
2033
2034=item Character class [:%s:] unknown
2035
2036(F) The class in the character class [: :] syntax is unknown.
437784d6 2037See L<perlre>.
a99ba403 2038
2039=item Character class syntax [%s] belongs inside character classes
2040
2041(W) The character class constructs [: :], [= =], and [. .] go
2042I<inside> character classes, the [] are part of the construct,
437784d6 2043for example: /[012[:alpha:]345]/. Note that [= =] and [. .]
2044are not currently implemented; they are simply placeholders for
2045future extensions.
a99ba403 2046
2047=item Constant is not %s reference
2048
2049(F) A constant value (perhaps declared using the C<use constant> pragma)
2050is being dereferenced, but it amounts to the wrong type of reference. The
2051message indicates the type of reference that was expected. This usually
2052indicates a syntax error in dereferencing the constant value.
2053See L<perlsub/"Constant Functions"> and L<constant>.
2054
2055=item constant(%s): %%^H is not localized
2056
2057(F) When setting compile-time-lexicalized hash %^H one should set the
2058corresponding bit of $^H as well.
2059
2060=item constant(%s): %s
2061
2062(F) Compile-time-substitutions (such as overloaded constants and
2063character names) were not correctly set up.
2064
2065=item defined(@array) is deprecated
2066
2067(D) defined() is not usually useful on arrays because it checks for an
2068undefined I<scalar> value. If you want to see if the array is empty,
2069just use C<if (@array) { # not empty }> for example.
2070
2071=item defined(%hash) is deprecated
2072
2073(D) defined() is not usually useful on hashes because it checks for an
2074undefined I<scalar> value. If you want to see if the hash is empty,
2075just use C<if (%hash) { # not empty }> for example.
2076
2077=item Did not produce a valid header
2078
2079See Server error.
2080
33633739 2081=item Did you mean "local" instead of "our"?
2082
2083(W) Remember that "our" does not localize the declared global variable.
2084You have declared it again in the same lexical scope, which seems superfluous.
2085
a99ba403 2086=item Document contains no data
2087
2088See Server error.
2089
2090=item entering effective %s failed
2091
2092(F) While under the C<use filetest> pragma, switching the real and
2093effective uids or gids failed.
6b121555 2094
73b437c8 2095=item false [] range "%s" in regexp
2096
2097(W) A character class range must start and end at a literal character, not
2098another character class like C<\d> or C<[:alpha:]>. The "-" in your false
2099range is interpreted as a literal "-". Consider quoting the "-", "\-".
2100See L<perlre>.
2101
af8c498a 2102=item Filehandle %s opened only for output
6b121555 2103
af8c498a 2104(W) You tried to read from a filehandle opened only for writing. If you
437784d6 2105intended it to be a read/write filehandle, you needed to open it with
af8c498a 2106"+E<lt>" or "+E<gt>" or "+E<gt>E<gt>" instead of with "E<lt>" or nothing. If
2107you intended only to read from the file, use "E<lt>". See
2108L<perlfunc/open>.
e02fdbd2 2109
56e90b21 2110=item flock() on closed filehandle %s
2111
2112(W) The filehandle you're attempting to flock() got itself closed some
2113time before now. Check your logic flow. flock() operates on filehandles.
2114Are you attempting to call flock() on a dirhandle by the same name?
2115
2116=item Global symbol "%s" requires explicit package name
2117
2118(F) You've said "use strict vars", which indicates that all variables
2119must either be lexically scoped (using "my"), declared beforehand using
2120"our", or explicitly qualified to say which package the global variable
2121is in (using "::").
2122
a99ba403 2123=item Hexadecimal number > 0xffffffff non-portable
2124
2125(W) The hexadecimal number you specified is larger than 2**32-1
2126(4294967295) and therefore non-portable between systems. See
2127L<perlport> for more on portability concerns.
2128
2129=item Ill-formed CRTL environ value "%s"
2130
2131(W) A warning peculiar to VMS. Perl tried to read the CRTL's internal
2132environ array, and encountered an element without the C<=> delimiter
2133used to spearate keys from values. The element is ignored.
2134
2135=item Ill-formed message in prime_env_iter: |%s|
2136
2137(W) A warning peculiar to VMS. Perl tried to read a logical name
2138or CLI symbol definition when preparing to iterate over %ENV, and
2139didn't see the expected delimiter between key and value, so the
2140line was ignored.
2141
2142=item Illegal binary digit %s
2143
437784d6 2144(F) You used a digit other than 0 or 1 in a binary number.
a99ba403 2145
2146=item Illegal binary digit %s ignored
2147
2148(W) You may have tried to use a digit other than 0 or 1 in a binary number.
2149Interpretation of the binary number stopped before the offending digit.
2150
2151=item Illegal number of bits in vec
2152
2153(F) The number of bits in vec() (the third argument) must be a power of
2154two from 1 to 32 (or 64, if your platform supports that).
2155
2156=item Integer overflow in %s number
2157
2158(W) The hexadecimal, octal or binary number you have specified either
c6edd1b7 2159as a literal or as an argument to hex() or oct() is too big for your
a99ba403 2160architecture, and has been converted to a floating point number. On a
216132-bit architecture the largest hexadecimal, octal or binary number
2162representable without overflow is 0xFFFFFFFF, 037777777777, or
21630b11111111111111111111111111111111 respectively. Note that Perl
2164transparently promotes all numbers to a floating point representation
2165internally--subject to loss of precision errors in subsequent
2166operations.
2167
09bef843 2168=item Invalid %s attribute: %s
2169
2170The indicated attribute for a subroutine or variable was not recognized
2171by Perl or by a user-supplied handler. See L<attributes>.
2172
2173=item Invalid %s attributes: %s
2174
2175The indicated attributes for a subroutine or variable were not recognized
2176by Perl or by a user-supplied handler. See L<attributes>.
2177
73b437c8 2178=item invalid [] range "%s" in regexp
2179
2180The offending range is now explicitly displayed.
2181
09bef843 2182=item Invalid separator character %s in attribute list
2183
0120eecf 2184(F) Something other than a colon or whitespace was seen between the
09bef843 2185elements of an attribute list. If the previous attribute
2186had a parenthesised parameter list, perhaps that list was terminated
2187too soon. See L<attributes>.
2188
a99ba403 2189=item Invalid separator character %s in subroutine attribute list
2190
0120eecf 2191(F) Something other than a colon or whitespace was seen between the
a99ba403 2192elements of a subroutine attribute list. If the previous attribute
2193had a parenthesised parameter list, perhaps that list was terminated
2194too soon.
2195
2196=item leaving effective %s failed
2197
2198(F) While under the C<use filetest> pragma, switching the real and
2199effective uids or gids failed.
2200
2201=item Lvalue subs returning %s not implemented yet
2202
2203(F) Due to limitations in the current implementation, array and hash
2204values cannot be returned in subroutines used in lvalue context.
2205See L<perlsub/"Lvalue subroutines">.
2206
2207=item Method %s not permitted
2208
2209See Server error.
2210
2211=item Missing %sbrace%s on \N{}
2212
2213(F) Wrong syntax of character name literal C<\N{charname}> within
2214double-quotish context.
2215
06eaf0bc 2216=item Missing command in piped open
2217
2218(W) You used the C<open(FH, "| command")> or C<open(FH, "command |")>
2219construction, but the command was missing or blank.
2220
09bef843 2221=item Missing name in "my sub"
2222
2223(F) The reserved syntax for lexically scoped subroutines requires that they
2224have a name with which they can be found.
2225
56e90b21 2226=item No %s specified for -%c
2227
2228(F) The indicated command line switch needs a mandatory argument, but
2229you haven't specified one.
2230
2231=item No package name allowed for variable %s in "our"
2232
2233(F) Fully qualified variable names are not allowed in "our" declarations,
2234because that doesn't make much sense under existing semantics. Such
2235syntax is reserved for future extensions.
2236
2237=item No space allowed after -%c
2238
2239(F) The argument to the indicated command line switch must follow immediately
2240after the switch, without intervening spaces.
2241
a99ba403 2242=item no UTC offset information; assuming local time is UTC
2243
2244(S) A warning peculiar to VMS. Perl was unable to find the local
2245timezone offset, so it's assuming that local system time is equivalent
2246to UTC. If it's not, define the logical name F<SYS$TIMEZONE_DIFFERENTIAL>
2247to translate to the number of seconds which need to be added to UTC to
2248get local time.
2249
2250=item Octal number > 037777777777 non-portable
2251
2252(W) The octal number you specified is larger than 2**32-1 (4294967295)
2253and therefore non-portable between systems. See L<perlport> for more
2254on portability concerns.
2255
2256See also L<perlport> for writing portable code.
2257
2258=item panic: del_backref
2259
2260(P) Failed an internal consistency check while trying to reset a weak
2261reference.
2262
2263=item panic: kid popen errno read
2264
2265(F) forked child returned an incomprehensible message about its errno.
2266
2267=item panic: magic_killbackrefs
2268
2269(P) Failed an internal consistency check while trying to reset all weak
2270references to an object.
2271
56e90b21 2272=item Parentheses missing around "%s" list
2273
2274(W) You said something like
2275
2276 my $foo, $bar = @_;
2277
2278when you meant
2279
2280 my ($foo, $bar) = @_;
2281
54884818 2282Remember that "my", "our", and "local" bind tighter than comma.
56e90b21 2283
a99ba403 2284=item Possible Y2K bug: %s
2285
2286(W) You are concatenating the number 19 with another number, which
2287could be a potential Year 2000 problem.
2288
2289=item Premature end of script headers
2290
2291See Server error.
2292
0b5b802d 2293=item Repeat count in pack overflows
2294
2295(F) You can't specify a repeat count so large that it overflows
2296your signed integers. See L<perlfunc/pack>.
2297
2298=item Repeat count in unpack overflows
2299
2300(F) You can't specify a repeat count so large that it overflows
2301your signed integers. See L<perlfunc/unpack>.
2302
a99ba403 2303=item realloc() of freed memory ignored
2304
2305(S) An internal routine called realloc() on something that had already
2306been freed.
2307
2308=item Reference is already weak
2309
2310(W) You have attempted to weaken a reference that is already weak.
2311Doing so has no effect.
2312
2313=item setpgrp can't take arguments
2314
2315(F) Your system has the setpgrp() from BSD 4.2, which takes no arguments,
2316unlike POSIX setpgid(), which takes a process ID and process group ID.
2317
2318=item Strange *+?{} on zero-length expression
2319
2320(W) You applied a regular expression quantifier in a place where it
2321makes no sense, such as on a zero-width assertion.
2322Try putting the quantifier inside the assertion instead. For example,
2323the way to match "abc" provided that it is followed by three
2324repetitions of "xyz" is C</abc(?=(?:xyz){3})/>, not C</abc(?=xyz){3}/>.
2325
2326=item switching effective %s is not implemented
2327
2328(F) While under the C<use filetest> pragma, we cannot switch the
2329real and effective uids or gids.
2330
437784d6 2331=item This Perl can't reset CRTL environ elements (%s)
a99ba403 2332
2333=item This Perl can't set CRTL environ elements (%s=%s)
2334
2335(W) Warnings peculiar to VMS. You tried to change or delete an element
2336of the CRTL's internal environ array, but your copy of Perl wasn't
2337built with a CRTL that contained the setenv() function. You'll need to
2338rebuild Perl with a CRTL that does, or redefine F<PERL_ENV_TABLES> (see
2339L<perlvms>) so that the environ array isn't the target of the change to
2340%ENV which produced the warning.
2341
2342=item Unknown open() mode '%s'
2343
437784d6 2344(F) The second argument of 3-argument open() is not among the list
1761cee5 2345of valid modes: C<E<lt>>, C<E<gt>>, C<E<gt>E<gt>>, C<+E<lt>>,
2346C<+E<gt>>, C<+E<gt>E<gt>>, C<-|>, C<|E<45>>.
a99ba403 2347
2348=item Unknown process %x sent message to prime_env_iter: %s
2349
2350(P) An error peculiar to VMS. Perl was reading values for %ENV before
2351iterating over it, and someone else stuck a message in the stream of
2352data Perl expected. Someone's very confused, or perhaps trying to
2353subvert Perl's population of %ENV for nefarious purposes.
2354
af8c498a 2355=item Unrecognized escape \\%c passed through
2356
2357(W) You used a backslash-character combination which is not recognized
1028017a 2358by Perl. The character was understood literally.
af8c498a 2359
09bef843 2360=item Unterminated attribute parameter in attribute list
2361
2362(F) The lexer saw an opening (left) parenthesis character while parsing an
2363attribute list, but the matching closing (right) parenthesis
2364character was not found. You may need to add (or remove) a backslash
2365character to get your parentheses to balance. See L<attributes>.
2366
2367=item Unterminated attribute list
2368
2369(F) The lexer found something other than a simple identifier at the start
2370of an attribute, and it wasn't a semicolon or the start of a
2371block. Perhaps you terminated the parameter list of the previous attribute
2372too soon. See L<attributes>.
2373
09bef843 2374=item Unterminated attribute parameter in subroutine attribute list
2375
2376(F) The lexer saw an opening (left) parenthesis character while parsing a
2377subroutine attribute list, but the matching closing (right) parenthesis
2378character was not found. You may need to add (or remove) a backslash
2379character to get your parentheses to balance.
2380
2381=item Unterminated subroutine attribute list
2382
2383(F) The lexer found something other than a simple identifier at the start
2384of a subroutine attribute, and it wasn't a semicolon or the start of a
2385block. Perhaps you terminated the parameter list of the previous attribute
2386too soon.
2387
a99ba403 2388=item Value of CLI symbol "%s" too long
eb6e2d6f 2389
a99ba403 2390(W) A warning peculiar to VMS. Perl tried to read the value of an %ENV
2391element from a CLI symbol table, and found a resultant string longer
2392than 1024 characters. The return value has been truncated to 1024
2393characters.
eb6e2d6f 2394
a99ba403 2395=item Version number must be a constant number
ba8251e8 2396
a99ba403 2397(P) The attempt to translate a C<use Module n.n LIST> statement into
2398its equivalent C<BEGIN> block found an internal inconsistency with
2399the version number.
2400
2401=back
27806c82 2402
a5222a85 2403=head1 Obsolete Diagnostics
3175b8cd 2404
a99ba403 2405=over 4
2406
2407=item Character class syntax [: :] is reserved for future extensions
2408
2409(W) Within regular expression character classes ([]) the syntax beginning
2410with "[:" and ending with ":]" is reserved for future extensions.
2411If you need to represent those character sequences inside a regular
2412expression character class, just quote the square brackets with the
2413backslash: "\[:" and ":\]".
2414
2415=item Ill-formed logical name |%s| in prime_env_iter
2416
2417(W) A warning peculiar to VMS. A logical name was encountered when preparing
2418to iterate over %ENV which violates the syntactic rules governing logical
2419names. Because it cannot be translated normally, it is skipped, and will not
2420appear in %ENV. This may be a benign occurrence, as some software packages
2421might directly modify logical name tables and introduce nonstandard names,
2422or it may indicate that a logical name table has been corrupted.
2423
34d09196 2424=item Probable precedence problem on %s
2425
2426(W) The compiler found a bareword where it expected a conditional,
2427which often indicates that an || or && was parsed as part of the
2428last argument of the previous construct, for example:
2429
2430 open FOO || die;
2431
a99ba403 2432=item regexp too big
2433
2434(F) The current implementation of regular expressions uses shorts as
2435address offsets within a string. Unfortunately this means that if
2436the regular expression compiles to longer than 32767, it'll blow up.
2437Usually when you want a regular expression this big, there is a better
2438way to do it with multiple statements. See L<perlre>.
2439
2440=item Use of "$$<digit>" to mean "${$}<digit>" is deprecated
2441
2442(D) Perl versions before 5.004 misinterpreted any type marker followed
2443by "$" and a digit. For example, "$$0" was incorrectly taken to mean
2444"${$}0" instead of "${$0}". This bug is (mostly) fixed in Perl 5.004.
2445
2446However, the developers of Perl 5.004 could not fix this bug completely,
2447because at least two widely-used modules depend on the old meaning of
2448"$$0" in a string. So Perl 5.004 still interprets "$$<digit>" in the
2449old (broken) way inside strings; but it generates this message as a
2450warning. And in Perl 5.005, this special treatment will cease.
2451
2452=back
3175b8cd 2453
ba8251e8 2454=head1 BUGS
2455
437784d6 2456If you find what you think is a bug, you might check the
14218588 2457articles recently posted to the comp.lang.perl.misc newsgroup.
ba8251e8 2458There may also be information at http://www.perl.com/perl/, the Perl
2459Home Page.
2460
2461If you believe you have an unreported bug, please run the B<perlbug>
14218588 2462program included with your release. Make sure to trim your bug down
ba8251e8 2463to a tiny but sufficient test case. Your bug report, along with the
14218588 2464output of C<perl -V>, will be sent off to perlbug@perl.com to be
ba8251e8 2465analysed by the Perl porting team.
2466
2467=head1 SEE ALSO
2468
2469The F<Changes> file for exhaustive details on what changed.
2470
2471The F<INSTALL> file for how to build Perl.
2472
2473The F<README> file for general stuff.
2474
2475The F<Artistic> and F<Copying> files for copyright information.
2476
2477=head1 HISTORY
2478
a5222a85 2479Written by Gurusamy Sarathy <F<gsar@activestate.com>>, with many
2480contributions from The Perl Porters.
ba8251e8 2481
2482Send omissions or corrections to <F<perlbug@perl.com>>.
2483
2484=cut