This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Revert "Make the peep recurse via PL_peepp"
[perl5.git] / pod / perl5134delta.pod
CommitLineData
e90f0e29
DG
1=encoding utf8
2
09d86ea5 3=for rafl
874cd4e1 4changelogged up to commit a98d1b3
09d86ea5 5* PERL_STATIC_INLINE might want to be mentioned
a98d1b31
FR
6* 5648c0a and 254f8c6 added an optimisation for backrefs. probably not worth
7mentioning
874cd4e1 8* RT#67838 needs mentioning. e2fe06d to 2154eca
a98d1b31 9
e90f0e29
DG
10=head1 NAME
11
12[ this is a template for a new perldelta file. Any text flagged as
13XXX needs to be processed before release. ]
14
15perldelta - what is new for perl v5.13.4
16
17=head1 DESCRIPTION
18
19This document describes differences between the 5.13.4 release and
20the 5.13.3 release.
21
22If you are upgrading from an earlier release such as 5.13.2, first read
23L<perl5133delta>, which describes differences between 5.13.2 and
245.13.3.
25
26=head1 Notice
27
28XXX Any important notices here
29
30=head1 Core Enhancements
31
32XXX New core language features go here. Summarise user-visible core language
33enhancements. Particularly prominent performance optimisations could go
34here, but most should go in the L</Performance Enhancements> section.
35
83832992
KW
36=head2 C<srand()> now returns the seed
37
38This allows programs which need to have repeatable results to not have to come
39up with their own seed generating mechanism. Instead, they can use C<srand()>
40and somehow stash the return for future use. Typical is a test program which
41has too many combinations to test comprehensively in the time available to it
a98d1b31
FR
42each run. It can test a random subset each time, and should there be a failure,
43log the seed used for that run so that it can later be used to reproduce the
44exact results.
45
874cd4e1
FR
46=head2 Creating unary functions with prototypes
47
48Calls to functions created with the following prototypes are now correctly parsed
49
50Functions declared with the following prototypes now behave correctly as unary functions:
51
52=over 4
53
54=item *
55
56*
57
58=item *
59
60\sigil
61
62=item *
63
64\[...]
65
66=item *
67
68;$
69
70=item *
71
72;*
73
74=item *
75
76;\sigil
77
78=item *
79
80;\[...]
81
82=back
83
a98d1b31
FR
84=head2 C<\N{I<name>}> and C<charnames> enhancements
85
86C<\N{}>, C<charnames::vianame>, C<charnames::viacode> now know about every
87character in Unicode. Previously, they didn't know about the Hangul syllables
88nor a number of CJK (Chinese/Japanese/Korean) characters.
83832992 89
e90f0e29
DG
90=head1 Security
91
92XXX Any security-related notices go here. In particular, any security
93vulnerabilities closed should be noted here rather than in the
94L</Selected Bug Fixes> section.
95
96[ List each security issue as a =head2 entry ]
97
98=head1 Incompatible Changes
99
dbce4399 100=head2 Declare API incompatibility between blead releases
e90f0e29 101
dbce4399
FR
102Only stable releases (5.10.x, 5.12.x, 5.14.x, ...) guarantee binary
103compatibility with each other, while blead releases (5.13.x, 5.15.x, ...) often
104break this compatibility. However, prior to perl 5.13.4, all blead releases had
105the same C<PERL_API_REVISION>, C<PERL_API_VERSION>, and C<PERL_API_SUBVERSION>,
106effectively declaring them as binary compatible, which they weren't. From now
107on, blead releases will have a C<PERL_API_SUBVERSION> equal to their
108C<PERL_SUBVERSION>, explicitly marking them as incompatible with each other.
e90f0e29 109
dbce4399
FR
110Maintainance releases of stable perl versions will continue to make no
111intentionally incompatible API changes.
112
113=head2 Check API compatibility when loading XS modules
114
115When perl's API changes in incompatible ways (which usually happens between
116every major release), XS modules compiled for previous versions of perl will not
117work anymore. They will need to be recompiled against the new perl.
118
119In order to ensure that modules are recompiled, and to prevent users from
120accidentally loading modules compiled for old perls into newer ones, the
121C<XS_APIVERSION_BOOTCHECK> macro has been added. That macro, which is called
122when loading every newly compiled extension, compares the API version of the
123running perl with the version a module has been compiled for and raises an
124exception if they don't match.
e90f0e29 125
e795e964
KW
126=head2 Binary Incompatible with all previous Perls
127
128Some bit fields have been reordered, hence this release will not be binary
129comptible with any previous Perl release.
130
e90f0e29
DG
131=head1 Deprecations
132
133XXX Any deprecated features, syntax, modules etc. should be listed here.
134In particular, deprecated modules should be listed here even if they are
135listed as an updated module in the L</Modules and Pragmata> section.
136
137[ List each deprecation as a =head2 entry ]
138
139=head1 Performance Enhancements
140
141XXX Changes which enhance performance without changing behaviour go here. There
142may well be none in a stable release.
143
144[ List each enhancement as a =item * entry ]
145
146=over 4
147
148=item *
149
874cd4e1
FR
150Make string appending 100 times faster
151
152When doing a lot of string appending, perl could end up allocating a lot more
153memory than needed in a very inefficient way, if perl was configured to use the
154system's C<malloc> implementation instead of its own.
155
156C<sv_grow>, which is what's being used to allocate more memory if necessary when
157appending to a string, has now been teached how to round up the memory it
158requests to a certain geometric progression, making it much faster on certain
159platforms and configurations. On Win32, it's now about 100 times faster.
160
161=item *
162
163C<XPV>, C<XPVIV>, and C<XPVNV> now only allocate the parts of the C<SV> body
164they actually use, saving some space.
e90f0e29
DG
165
166=back
167
168=head1 Modules and Pragmata
169
170XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
171go here. If Module::CoreList is updated, generate an initial draft of the
172following sections using F<Porting/corelist-perldelta.pl>, which prints stub
173entries to STDOUT. Results can be pasted in place of the '=head2' entries
174below. A paragraph summary for important changes should then be added by hand.
175In an ideal world, dual-life modules would have a F<Changes> file that could be
176cribbed.
177
178[ Within each section, list entries as a =item NAME entry ]
179
180=head2 New Modules and Pragmata
181
182=over 4
183
184=item *
185
186XXX
187
188=back
189
190=head2 Updated Modules and Pragmata
191
192=over 4
193
5aa76647
FR
194=item C<Archive::Tar>
195
196Upgraded from version 1.64 to 1.66.
197
198Among other things, the new version adds a new option to C<ptar> to allow safe
199creation of tarballs without world-writable files on Windows, allowing those
200archives to be uploaded to CPAN.
201
a767f83c
FR
202=item C<B::Lint>
203
204Upgraded from version 1.11 to 1.12.
205
09d86ea5 206=item C<Carp>
e90f0e29 207
09d86ea5
FR
208Upgraded from version 1.16 to 1.18.
209
210L<Carp> now detects incomplete L<caller()|perlfunc/"caller EXPR"> overrides and
211avoids using bogus C<@DB::args>. This fixes certain cases of C<Bizarre copy of
212ARRAY> caused by modules overriding C<caller()> incorrectly.
213
97613388
FR
214=item C<Compress::Raw::Bzip2>
215
216Upgraded from version 2.027 to 2.030.
217
218=item C<Compress::Raw::Zlib>
219
220Upgraded from version 2.027 to 2.030.
221
09d86ea5
FR
222=item C<File::Spec>
223
224Upgraded from version 3.31 to 3.31_01.
225
226Various issues in L<File::Spec::VMS> have been fixed.
e90f0e29 227
97613388
FR
228=item C<IO::Compress>
229
230Upgraded from version 2.027 to 2.030.
231
874cd4e1
FR
232=item C<Test::Simple>
233
234Upgraded from version 0.94 to 0.96.
235
236Among many other things, subtests without a C<plan> or C<no_plan> now have an
237implicit C<done_testing()> added to them.
238
a98d1b31
FR
239=item C<Unicode::Collate>
240
241Upgraded from version 0.53 to 0.56.
242
243Among other things, it is now using UCA Revision 20 (based on Unicode 5.2.0) and
244supports a couple of new locales.
245
e90f0e29
DG
246=back
247
248=head2 Removed Modules and Pragmata
249
250=over 4
251
252=item *
253
254XXX
255
256=back
257
258=head1 Documentation
259
260XXX Changes to files in F<pod/> go here. Consider grouping entries by
261file and be sure to link to the appropriate page, e.g. L<perlfunc>.
262
263=head2 New Documentation
264
265XXX Changes which create B<new> files in F<pod/> go here.
266
267=head3 L<XXX>
268
269XXX Description of the purpose of the new file here
270
271=head2 Changes to Existing Documentation
272
273XXX Changes which significantly change existing files in F<pod/> go here.
274However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
275section.
276
dbce4399
FR
277=head3 L<perldiag>
278
279=over 4
280
281=item *
282
283The following existing diagnostics are now documented:
284
285=over 4
286
287=item *
288
289L<Ambiguous use of %c resolved as operator %c|perldiag/"Ambiguous use of %c resolved as operator %c">
290
291=item *
292
293L<Ambiguous use of %c{%s} resolved to %c%s|perldiag/"Ambiguous use of %c{%s} resolved to %c%s">
294
295=item *
296
297L<Ambiguous use of %c{%s%s} resolved to %c%s%s|perldiag/"Ambiguous use of %c{%s%s} resolved to %c%s%s">
298
299=item *
300
301L<Ambiguous use of -%s resolved as -&%s()|perldiag/"Ambiguous use of -%s resolved as -&%s()">
302
874cd4e1
FR
303=item *
304
305L<Invalid strict version format (%s)|perldiag/"Invalid strict version format (%s)">
306
307=item *
308
309L<Invalid version format (%s)|perldiag/"Invalid version format (%s)">
310
311=item *
312
313L<Invalid version object|perldiag/"Invalid version object">
314
dbce4399
FR
315=back
316
317=back
318
09d86ea5 319=head3 L<perlport>
e90f0e29
DG
320
321=over 4
322
323=item *
324
09d86ea5
FR
325Documented a L<limitation|perlport/alarm> of L<alarm()|perlfunc/"alarm SECONDS">
326on Win32.
e90f0e29
DG
327
328=back
329
874cd4e1
FR
330=head3 L<perlre>
331
332=over 4
333
334=item *
335
336Minor fix to a multiple scalar match example.
337
338=back
339
e90f0e29
DG
340=head1 Diagnostics
341
342The following additions or changes have been made to diagnostic output,
343including warnings and fatal error messages. For the complete list of
344diagnostic messages, see L<perldiag>.
345
346XXX New or changed warnings emitted by the core's C<C> code go here. Also
347include any changes in L<perldiag> that reconcile it to the C<C> code.
348
349[ Within each section, list entries as a =item entry ]
350
351=head2 New Diagnostics
352
353XXX Newly added diagnostic messages go here
354
355=over 4
356
357=item *
358
359XXX
360
361=back
362
363=head2 Changes to Existing Diagnostics
364
365XXX Changes (i.e. rewording) of diagnostic messages go here
366
367=over 4
368
369=item *
370
371XXX
372
373=back
374
375=head1 Utility Changes
376
377XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
378here. Most of these are built within the directories F<utils> and F<x2p>.
379
380[ List utility changes as a =head3 entry for each utility and =item
381entries for each change
382Use L<XXX> with program names to get proper documentation linking. ]
383
384=head3 L<XXX>
385
386=over 4
387
388=item *
389
390XXX
391
392=back
393
394=head1 Configuration and Compilation
395
396XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
397go here. Any other changes to the Perl build process should be listed here.
398However, any platform-specific changes should be listed in the
399L</Platform Support> section, instead.
400
401[ List changes as a =item entry ].
402
403=over 4
404
405=item *
406
874cd4e1
FR
407Compatibility with C<C++> compilers has been improved.
408
409=item *
410
411On compilers that support it, C<-Wwrite-strings> is now added to cflags by
412default.
e90f0e29
DG
413
414=back
415
416=head1 Testing
417
418XXX Any significant changes to the testing of a freshly built perl should be
419listed here. Changes which create B<new> files in F<t/> go here as do any
420large changes to the testing harness (e.g. when parallel testing was added).
421Changes to existing files in F<t/> aren't worth summarising, although the bugs
422that they represent may be covered elsewhere.
423
424[ List each test improvement as a =item entry ]
425
426=over 4
427
428=item *
429
5aa76647 430F<t/op/print.t> has been added to test implicit printing of C<$_>.
e90f0e29 431
dbce4399
FR
432=item *
433
434F<t/io/errnosig.t> has been added to test for restoration of of C<$!> when
435leaving signal handlers.
436
a98d1b31
FR
437=item *
438
439F<t/op/tie_fetch_count.t> has been added to see if C<FETCH> is only called once
440on tied variables.
441
442=item *
443
444F<lib/Tie/ExtraHash.t> has been added to make sure the, previously untested,
445L<Tie::ExtraHash> keeps working.
446
e90f0e29
DG
447=back
448
449=head1 Platform Support
450
451XXX Any changes to platform support should be listed in the sections below.
452
453[ Within the sections, list each platform as a =item entry with specific
454changes as paragraphs below it. ]
455
456=head2 New Platforms
457
458XXX List any platforms that this version of perl compiles on, that previous
459versions did not. These will either be enabled by new files in the F<hints/>
460directories, or new subdirectories and F<README> files at the top level of the
461source tree.
462
463=over 4
464
465=item XXX-some-platform
466
467XXX
468
469=back
470
471=head2 Discontinued Platforms
472
473XXX List any platforms that this version of perl no longer compiles on.
474
475=over 4
476
477=item XXX-some-platform
478
479XXX
480
481=back
482
483=head2 Platform-Specific Notes
484
485XXX List any changes for specific platforms. This could include configuration
486and compilation changes or changes in portability/compatibility. However,
487changes within modules for platforms should generally be listed in the
488L</Modules and Pragmata> section.
489
490=over 4
491
09d86ea5 492=item Win32
e90f0e29 493
09d86ea5
FR
494=over 4
495
496=item *
497
498Fixed a possible hang in F<t/op/readline.t>.
499
500=item *
501
502Fixed Makefile for SDK2003SP1 compilers.
503
a98d1b31
FR
504=item *
505
506When using old 32-bit compilers, the define C<_USE_32BIT_TIME_T> will now be set
507in C<$Config{ccflags}>. This improves portability when compiling XS extensions
508using new compilers, but for a perl compiled with old 32-bit compilers.
509
09d86ea5 510=back
e90f0e29
DG
511
512=back
513
514=head1 Internal Changes
515
516XXX Changes which affect the interface available to C<XS> code go here.
517Other significant internal changes for future core maintainers should
518be noted as well.
519
520[ List each test improvement as a =item entry ]
521
522=over 4
523
09d86ea5 524=item Removed C<PERL_POLLUTE>
e90f0e29 525
09d86ea5
FR
526The option to define C<PERL_POLLUTE> to expose older 5.005 symbols for backwards
527compatibility has been removed. It's use was always discouraged, and MakeMaker
528contains a more specific escape hatch:
529
530 perl Makefile.PL POLLUTE=1
531
532This can be used for modules that have not been upgraded to 5.6 naming
533conventions (and really should be completely obsolete by now).
534
a98d1b31
FR
535=item C<Perl_grok_bslash_o> and C<Perl_grok_bslash_c> may change in future
536
537The functions C<Perl_grok_bslash_o> and C<Perl_grok_bslash_c>, which are public
538and exported for use by dynamic extensions, are now marked as being able to
539change their interface in the future.
540
541In fact, C<Perl_grok_bslash_o> already changed its interface in this release,
542and returns a C<bool> instead of a C<char> now.
543
e90f0e29
DG
544=back
545
546=head1 Selected Bug Fixes
547
548XXX Important bug fixes in the core language are summarised here.
549Bug fixes in files in F<ext/> and F<lib/> are best summarised in
550L</Modules and Pragmata>.
551
552[ List each fix as a =item entry ]
553
554=over 4
555
556=item *
557
09d86ea5
FR
558Fixed possible memory leak when using L<caller()|perlfunc/"caller EXPR"> to set
559C<@DB::args>.
560
561=item *
562
563Several memory leaks when loading XS modules were fixed.
e90f0e29 564
5aa76647
FR
565=item *
566
567A panic in the regular expression optimizer has been fixed (RT#75762).
568
569=item *
570
571Assignments to lvalue subroutines now honor copy-on-write behavior again, which
572has been broken since version 5.10.0 (RT#75656).
573
dbce4399
FR
574=item *
575
576Assignments to glob copies now behave just like assignments to regular globs
577(RT#1804).
578
579=item *
580
581Within signal handlers, C<$!> is now implicitly localized.
582
874cd4e1
FR
583=item *
584
585L<readline|perlfunc/"readline EXPR"> now honors C<< <> >> overloading on tied
586arguments.
587
e90f0e29
DG
588=back
589
590=head1 Known Problems
591
592XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
593tests that had to be C<TODO>ed for the release would be noted here, unless
594they were specific to a particular platform (see below).
595
596This is a list of some significant unfixed bugs, which are regressions
597from either 5.XXX.XXX or 5.XXX.XXX.
598
599[ List each fix as a =item entry ]
600
601=over 4
602
603=item *
604
605XXX
606
607=back
608
609=head1 Obituary
610
611XXX If any significant core contributor has died, we've added a short obituary
612here.
613
614=head1 Acknowledgements
615
616XXX The list of people to thank goes here.
617
618=head1 Reporting Bugs
619
620If you find what you think is a bug, you might check the articles
621recently posted to the comp.lang.perl.misc newsgroup and the perl
622bug database at http://rt.perl.org/perlbug/ . There may also be
623information at http://www.perl.org/ , the Perl Home Page.
624
625If you believe you have an unreported bug, please run the B<perlbug>
626program included with your release. Be sure to trim your bug down
627to a tiny but sufficient test case. Your bug report, along with the
628output of C<perl -V>, will be sent off to perlbug@perl.org to be
629analysed by the Perl porting team.
630
631If the bug you are reporting has security implications, which make it
632inappropriate to send to a publicly archived mailing list, then please send
633it to perl5-security-report@perl.org. This points to a closed subscription
634unarchived mailing list, which includes all the core committers, who be able
635to help assess the impact of issues, figure out a resolution, and help
636co-ordinate the release of patches to mitigate or fix the problem across all
637platforms on which Perl is supported. Please only use this address for
638security issues in the Perl core, not for modules independently
639distributed on CPAN.
640
641=head1 SEE ALSO
642
643The F<Changes> file for an explanation of how to view exhaustive details
644on what changed.
645
646The F<INSTALL> file for how to build Perl.
647
648The F<README> file for general stuff.
649
650The F<Artistic> and F<Copying> files for copyright information.
651
652=cut