This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta up to d6fa5a34
[perl5.git] / pod / perl5134delta.pod
CommitLineData
e90f0e29
DG
1=encoding utf8
2
09d86ea5 3=for rafl
dbce4399 4changelogged up to commit d6fa5a34
09d86ea5 5* PERL_STATIC_INLINE might want to be mentioned
09d86ea5 6
e90f0e29
DG
7=head1 NAME
8
9[ this is a template for a new perldelta file. Any text flagged as
10XXX needs to be processed before release. ]
11
12perldelta - what is new for perl v5.13.4
13
14=head1 DESCRIPTION
15
16This document describes differences between the 5.13.4 release and
17the 5.13.3 release.
18
19If you are upgrading from an earlier release such as 5.13.2, first read
20L<perl5133delta>, which describes differences between 5.13.2 and
215.13.3.
22
23=head1 Notice
24
25XXX Any important notices here
26
27=head1 Core Enhancements
28
29XXX New core language features go here. Summarise user-visible core language
30enhancements. Particularly prominent performance optimisations could go
31here, but most should go in the L</Performance Enhancements> section.
32
33[ List each enhancement as a =head2 entry ]
34
35=head1 Security
36
37XXX Any security-related notices go here. In particular, any security
38vulnerabilities closed should be noted here rather than in the
39L</Selected Bug Fixes> section.
40
41[ List each security issue as a =head2 entry ]
42
43=head1 Incompatible Changes
44
dbce4399 45=head2 Declare API incompatibility between blead releases
e90f0e29 46
dbce4399
FR
47Only stable releases (5.10.x, 5.12.x, 5.14.x, ...) guarantee binary
48compatibility with each other, while blead releases (5.13.x, 5.15.x, ...) often
49break this compatibility. However, prior to perl 5.13.4, all blead releases had
50the same C<PERL_API_REVISION>, C<PERL_API_VERSION>, and C<PERL_API_SUBVERSION>,
51effectively declaring them as binary compatible, which they weren't. From now
52on, blead releases will have a C<PERL_API_SUBVERSION> equal to their
53C<PERL_SUBVERSION>, explicitly marking them as incompatible with each other.
e90f0e29 54
dbce4399
FR
55Maintainance releases of stable perl versions will continue to make no
56intentionally incompatible API changes.
57
58=head2 Check API compatibility when loading XS modules
59
60When perl's API changes in incompatible ways (which usually happens between
61every major release), XS modules compiled for previous versions of perl will not
62work anymore. They will need to be recompiled against the new perl.
63
64In order to ensure that modules are recompiled, and to prevent users from
65accidentally loading modules compiled for old perls into newer ones, the
66C<XS_APIVERSION_BOOTCHECK> macro has been added. That macro, which is called
67when loading every newly compiled extension, compares the API version of the
68running perl with the version a module has been compiled for and raises an
69exception if they don't match.
e90f0e29
DG
70
71=head1 Deprecations
72
73XXX Any deprecated features, syntax, modules etc. should be listed here.
74In particular, deprecated modules should be listed here even if they are
75listed as an updated module in the L</Modules and Pragmata> section.
76
77[ List each deprecation as a =head2 entry ]
78
79=head1 Performance Enhancements
80
81XXX Changes which enhance performance without changing behaviour go here. There
82may well be none in a stable release.
83
84[ List each enhancement as a =item * entry ]
85
86=over 4
87
88=item *
89
90XXX
91
92=back
93
94=head1 Modules and Pragmata
95
96XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97go here. If Module::CoreList is updated, generate an initial draft of the
98following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99entries to STDOUT. Results can be pasted in place of the '=head2' entries
100below. A paragraph summary for important changes should then be added by hand.
101In an ideal world, dual-life modules would have a F<Changes> file that could be
102cribbed.
103
104[ Within each section, list entries as a =item NAME entry ]
105
106=head2 New Modules and Pragmata
107
108=over 4
109
110=item *
111
112XXX
113
114=back
115
116=head2 Updated Modules and Pragmata
117
118=over 4
119
5aa76647
FR
120=item C<Archive::Tar>
121
122Upgraded from version 1.64 to 1.66.
123
124Among other things, the new version adds a new option to C<ptar> to allow safe
125creation of tarballs without world-writable files on Windows, allowing those
126archives to be uploaded to CPAN.
127
a767f83c
FR
128=item C<B::Lint>
129
130Upgraded from version 1.11 to 1.12.
131
09d86ea5 132=item C<Carp>
e90f0e29 133
09d86ea5
FR
134Upgraded from version 1.16 to 1.18.
135
136L<Carp> now detects incomplete L<caller()|perlfunc/"caller EXPR"> overrides and
137avoids using bogus C<@DB::args>. This fixes certain cases of C<Bizarre copy of
138ARRAY> caused by modules overriding C<caller()> incorrectly.
139
97613388
FR
140=item C<Compress::Raw::Bzip2>
141
142Upgraded from version 2.027 to 2.030.
143
144=item C<Compress::Raw::Zlib>
145
146Upgraded from version 2.027 to 2.030.
147
09d86ea5
FR
148=item C<File::Spec>
149
150Upgraded from version 3.31 to 3.31_01.
151
152Various issues in L<File::Spec::VMS> have been fixed.
e90f0e29 153
97613388
FR
154=item C<IO::Compress>
155
156Upgraded from version 2.027 to 2.030.
157
e90f0e29
DG
158=back
159
160=head2 Removed Modules and Pragmata
161
162=over 4
163
164=item *
165
166XXX
167
168=back
169
170=head1 Documentation
171
172XXX Changes to files in F<pod/> go here. Consider grouping entries by
173file and be sure to link to the appropriate page, e.g. L<perlfunc>.
174
175=head2 New Documentation
176
177XXX Changes which create B<new> files in F<pod/> go here.
178
179=head3 L<XXX>
180
181XXX Description of the purpose of the new file here
182
183=head2 Changes to Existing Documentation
184
185XXX Changes which significantly change existing files in F<pod/> go here.
186However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
187section.
188
dbce4399
FR
189=head3 L<perldiag>
190
191=over 4
192
193=item *
194
195The following existing diagnostics are now documented:
196
197=over 4
198
199=item *
200
201L<Ambiguous use of %c resolved as operator %c|perldiag/"Ambiguous use of %c resolved as operator %c">
202
203=item *
204
205L<Ambiguous use of %c{%s} resolved to %c%s|perldiag/"Ambiguous use of %c{%s} resolved to %c%s">
206
207=item *
208
209L<Ambiguous use of %c{%s%s} resolved to %c%s%s|perldiag/"Ambiguous use of %c{%s%s} resolved to %c%s%s">
210
211=item *
212
213L<Ambiguous use of -%s resolved as -&%s()|perldiag/"Ambiguous use of -%s resolved as -&%s()">
214
215=back
216
217=back
218
09d86ea5 219=head3 L<perlport>
e90f0e29
DG
220
221=over 4
222
223=item *
224
09d86ea5
FR
225Documented a L<limitation|perlport/alarm> of L<alarm()|perlfunc/"alarm SECONDS">
226on Win32.
e90f0e29
DG
227
228=back
229
230=head1 Diagnostics
231
232The following additions or changes have been made to diagnostic output,
233including warnings and fatal error messages. For the complete list of
234diagnostic messages, see L<perldiag>.
235
236XXX New or changed warnings emitted by the core's C<C> code go here. Also
237include any changes in L<perldiag> that reconcile it to the C<C> code.
238
239[ Within each section, list entries as a =item entry ]
240
241=head2 New Diagnostics
242
243XXX Newly added diagnostic messages go here
244
245=over 4
246
247=item *
248
249XXX
250
251=back
252
253=head2 Changes to Existing Diagnostics
254
255XXX Changes (i.e. rewording) of diagnostic messages go here
256
257=over 4
258
259=item *
260
261XXX
262
263=back
264
265=head1 Utility Changes
266
267XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
268here. Most of these are built within the directories F<utils> and F<x2p>.
269
270[ List utility changes as a =head3 entry for each utility and =item
271entries for each change
272Use L<XXX> with program names to get proper documentation linking. ]
273
274=head3 L<XXX>
275
276=over 4
277
278=item *
279
280XXX
281
282=back
283
284=head1 Configuration and Compilation
285
286XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
287go here. Any other changes to the Perl build process should be listed here.
288However, any platform-specific changes should be listed in the
289L</Platform Support> section, instead.
290
291[ List changes as a =item entry ].
292
293=over 4
294
295=item *
296
09d86ea5 297Improve compatibility with C<C++> compilers.
e90f0e29
DG
298
299=back
300
301=head1 Testing
302
303XXX Any significant changes to the testing of a freshly built perl should be
304listed here. Changes which create B<new> files in F<t/> go here as do any
305large changes to the testing harness (e.g. when parallel testing was added).
306Changes to existing files in F<t/> aren't worth summarising, although the bugs
307that they represent may be covered elsewhere.
308
309[ List each test improvement as a =item entry ]
310
311=over 4
312
313=item *
314
5aa76647 315F<t/op/print.t> has been added to test implicit printing of C<$_>.
e90f0e29 316
dbce4399
FR
317=item *
318
319F<t/io/errnosig.t> has been added to test for restoration of of C<$!> when
320leaving signal handlers.
321
e90f0e29
DG
322=back
323
324=head1 Platform Support
325
326XXX Any changes to platform support should be listed in the sections below.
327
328[ Within the sections, list each platform as a =item entry with specific
329changes as paragraphs below it. ]
330
331=head2 New Platforms
332
333XXX List any platforms that this version of perl compiles on, that previous
334versions did not. These will either be enabled by new files in the F<hints/>
335directories, or new subdirectories and F<README> files at the top level of the
336source tree.
337
338=over 4
339
340=item XXX-some-platform
341
342XXX
343
344=back
345
346=head2 Discontinued Platforms
347
348XXX List any platforms that this version of perl no longer compiles on.
349
350=over 4
351
352=item XXX-some-platform
353
354XXX
355
356=back
357
358=head2 Platform-Specific Notes
359
360XXX List any changes for specific platforms. This could include configuration
361and compilation changes or changes in portability/compatibility. However,
362changes within modules for platforms should generally be listed in the
363L</Modules and Pragmata> section.
364
365=over 4
366
09d86ea5 367=item Win32
e90f0e29 368
09d86ea5
FR
369=over 4
370
371=item *
372
373Fixed a possible hang in F<t/op/readline.t>.
374
375=item *
376
377Fixed Makefile for SDK2003SP1 compilers.
378
379=back
e90f0e29
DG
380
381=back
382
383=head1 Internal Changes
384
385XXX Changes which affect the interface available to C<XS> code go here.
386Other significant internal changes for future core maintainers should
387be noted as well.
388
389[ List each test improvement as a =item entry ]
390
391=over 4
392
09d86ea5 393=item Removed C<PERL_POLLUTE>
e90f0e29 394
09d86ea5
FR
395The option to define C<PERL_POLLUTE> to expose older 5.005 symbols for backwards
396compatibility has been removed. It's use was always discouraged, and MakeMaker
397contains a more specific escape hatch:
398
399 perl Makefile.PL POLLUTE=1
400
401This can be used for modules that have not been upgraded to 5.6 naming
402conventions (and really should be completely obsolete by now).
403
844fcee5
FR
404=item Make extending the peephole optimizer easier
405
406As of version 5.8, extension authors were allowed to replace perl's peephole
407optimizer function. However, this was B<very> hard to do, as there was no way to
408add new optimizations without having to copy large parts of perl's original
409optimizer. This problem is now solved by a rework of the optimizer extension
410API. See L<perlguts/"Compile pass 3: peephole optimization"> for details.
411
e90f0e29
DG
412=back
413
414=head1 Selected Bug Fixes
415
416XXX Important bug fixes in the core language are summarised here.
417Bug fixes in files in F<ext/> and F<lib/> are best summarised in
418L</Modules and Pragmata>.
419
420[ List each fix as a =item entry ]
421
422=over 4
423
424=item *
425
09d86ea5
FR
426Fixed possible memory leak when using L<caller()|perlfunc/"caller EXPR"> to set
427C<@DB::args>.
428
429=item *
430
431Several memory leaks when loading XS modules were fixed.
e90f0e29 432
5aa76647
FR
433=item *
434
435A panic in the regular expression optimizer has been fixed (RT#75762).
436
437=item *
438
439Assignments to lvalue subroutines now honor copy-on-write behavior again, which
440has been broken since version 5.10.0 (RT#75656).
441
dbce4399
FR
442=item *
443
444Assignments to glob copies now behave just like assignments to regular globs
445(RT#1804).
446
447=item *
448
449Within signal handlers, C<$!> is now implicitly localized.
450
e90f0e29
DG
451=back
452
453=head1 Known Problems
454
455XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
456tests that had to be C<TODO>ed for the release would be noted here, unless
457they were specific to a particular platform (see below).
458
459This is a list of some significant unfixed bugs, which are regressions
460from either 5.XXX.XXX or 5.XXX.XXX.
461
462[ List each fix as a =item entry ]
463
464=over 4
465
466=item *
467
468XXX
469
470=back
471
472=head1 Obituary
473
474XXX If any significant core contributor has died, we've added a short obituary
475here.
476
477=head1 Acknowledgements
478
479XXX The list of people to thank goes here.
480
481=head1 Reporting Bugs
482
483If you find what you think is a bug, you might check the articles
484recently posted to the comp.lang.perl.misc newsgroup and the perl
485bug database at http://rt.perl.org/perlbug/ . There may also be
486information at http://www.perl.org/ , the Perl Home Page.
487
488If you believe you have an unreported bug, please run the B<perlbug>
489program included with your release. Be sure to trim your bug down
490to a tiny but sufficient test case. Your bug report, along with the
491output of C<perl -V>, will be sent off to perlbug@perl.org to be
492analysed by the Perl porting team.
493
494If the bug you are reporting has security implications, which make it
495inappropriate to send to a publicly archived mailing list, then please send
496it to perl5-security-report@perl.org. This points to a closed subscription
497unarchived mailing list, which includes all the core committers, who be able
498to help assess the impact of issues, figure out a resolution, and help
499co-ordinate the release of patches to mitigate or fix the problem across all
500platforms on which Perl is supported. Please only use this address for
501security issues in the Perl core, not for modules independently
502distributed on CPAN.
503
504=head1 SEE ALSO
505
506The F<Changes> file for an explanation of how to view exhaustive details
507on what changed.
508
509The F<INSTALL> file for how to build Perl.
510
511The F<README> file for general stuff.
512
513The F<Artistic> and F<Copying> files for copyright information.
514
515=cut