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