This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Ignore some more test byproducts
[perl5.git] / pod / perl5134delta.pod
CommitLineData
e90f0e29
DG
1=encoding utf8
2
09d86ea5 3=for rafl
97613388 4changelogged up to commit a095c4ee
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
09d86ea5 101=item C<Carp>
e90f0e29 102
09d86ea5
FR
103Upgraded from version 1.16 to 1.18.
104
105L<Carp> now detects incomplete L<caller()|perlfunc/"caller EXPR"> overrides and
106avoids using bogus C<@DB::args>. This fixes certain cases of C<Bizarre copy of
107ARRAY> caused by modules overriding C<caller()> incorrectly.
108
97613388
FR
109=item C<Compress::Raw::Bzip2>
110
111Upgraded from version 2.027 to 2.030.
112
113=item C<Compress::Raw::Zlib>
114
115Upgraded from version 2.027 to 2.030.
116
09d86ea5
FR
117=item C<File::Spec>
118
119Upgraded from version 3.31 to 3.31_01.
120
121Various issues in L<File::Spec::VMS> have been fixed.
e90f0e29 122
97613388
FR
123=item C<IO::Compress>
124
125Upgraded from version 2.027 to 2.030.
126
e90f0e29
DG
127=back
128
129=head2 Removed Modules and Pragmata
130
131=over 4
132
133=item *
134
135XXX
136
137=back
138
139=head1 Documentation
140
141XXX Changes to files in F<pod/> go here. Consider grouping entries by
142file and be sure to link to the appropriate page, e.g. L<perlfunc>.
143
144=head2 New Documentation
145
146XXX Changes which create B<new> files in F<pod/> go here.
147
148=head3 L<XXX>
149
150XXX Description of the purpose of the new file here
151
152=head2 Changes to Existing Documentation
153
154XXX Changes which significantly change existing files in F<pod/> go here.
155However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
156section.
157
09d86ea5 158=head3 L<perlport>
e90f0e29
DG
159
160=over 4
161
162=item *
163
09d86ea5
FR
164Documented a L<limitation|perlport/alarm> of L<alarm()|perlfunc/"alarm SECONDS">
165on Win32.
e90f0e29
DG
166
167=back
168
169=head1 Diagnostics
170
171The following additions or changes have been made to diagnostic output,
172including warnings and fatal error messages. For the complete list of
173diagnostic messages, see L<perldiag>.
174
175XXX New or changed warnings emitted by the core's C<C> code go here. Also
176include any changes in L<perldiag> that reconcile it to the C<C> code.
177
178[ Within each section, list entries as a =item entry ]
179
180=head2 New Diagnostics
181
182XXX Newly added diagnostic messages go here
183
184=over 4
185
186=item *
187
188XXX
189
190=back
191
192=head2 Changes to Existing Diagnostics
193
194XXX Changes (i.e. rewording) of diagnostic messages go here
195
196=over 4
197
198=item *
199
200XXX
201
202=back
203
204=head1 Utility Changes
205
206XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
207here. Most of these are built within the directories F<utils> and F<x2p>.
208
209[ List utility changes as a =head3 entry for each utility and =item
210entries for each change
211Use L<XXX> with program names to get proper documentation linking. ]
212
213=head3 L<XXX>
214
215=over 4
216
217=item *
218
219XXX
220
221=back
222
223=head1 Configuration and Compilation
224
225XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
226go here. Any other changes to the Perl build process should be listed here.
227However, any platform-specific changes should be listed in the
228L</Platform Support> section, instead.
229
230[ List changes as a =item entry ].
231
232=over 4
233
234=item *
235
09d86ea5 236Improve compatibility with C<C++> compilers.
e90f0e29
DG
237
238=back
239
240=head1 Testing
241
242XXX Any significant changes to the testing of a freshly built perl should be
243listed here. Changes which create B<new> files in F<t/> go here as do any
244large changes to the testing harness (e.g. when parallel testing was added).
245Changes to existing files in F<t/> aren't worth summarising, although the bugs
246that they represent may be covered elsewhere.
247
248[ List each test improvement as a =item entry ]
249
250=over 4
251
252=item *
253
254XXX
255
256=back
257
258=head1 Platform Support
259
260XXX Any changes to platform support should be listed in the sections below.
261
262[ Within the sections, list each platform as a =item entry with specific
263changes as paragraphs below it. ]
264
265=head2 New Platforms
266
267XXX List any platforms that this version of perl compiles on, that previous
268versions did not. These will either be enabled by new files in the F<hints/>
269directories, or new subdirectories and F<README> files at the top level of the
270source tree.
271
272=over 4
273
274=item XXX-some-platform
275
276XXX
277
278=back
279
280=head2 Discontinued Platforms
281
282XXX List any platforms that this version of perl no longer compiles on.
283
284=over 4
285
286=item XXX-some-platform
287
288XXX
289
290=back
291
292=head2 Platform-Specific Notes
293
294XXX List any changes for specific platforms. This could include configuration
295and compilation changes or changes in portability/compatibility. However,
296changes within modules for platforms should generally be listed in the
297L</Modules and Pragmata> section.
298
299=over 4
300
09d86ea5 301=item Win32
e90f0e29 302
09d86ea5
FR
303=over 4
304
305=item *
306
307Fixed a possible hang in F<t/op/readline.t>.
308
309=item *
310
311Fixed Makefile for SDK2003SP1 compilers.
312
313=back
e90f0e29
DG
314
315=back
316
317=head1 Internal Changes
318
319XXX Changes which affect the interface available to C<XS> code go here.
320Other significant internal changes for future core maintainers should
321be noted as well.
322
323[ List each test improvement as a =item entry ]
324
325=over 4
326
09d86ea5 327=item Removed C<PERL_POLLUTE>
e90f0e29 328
09d86ea5
FR
329The option to define C<PERL_POLLUTE> to expose older 5.005 symbols for backwards
330compatibility has been removed. It's use was always discouraged, and MakeMaker
331contains a more specific escape hatch:
332
333 perl Makefile.PL POLLUTE=1
334
335This can be used for modules that have not been upgraded to 5.6 naming
336conventions (and really should be completely obsolete by now).
337
338=item Declare API incompatibility between blead releases
339
340Only stable releases (5.10.x, 5.12.x, 5.14.x, ...) guarantee binary
341compatibility with each other, while blead releases (5.13.x, 5.15.x, ...) often
342break this compatibility. However, prior to perl 5.13.4, all blead releases had
343the same C<PERL_API_REVISION>, C<PERL_API_VERSION>, and C<PERL_API_SUBVERSION>,
344effectively declaring them as binary compatible, which they weren't. From now
345on, blead releases will have a C<PERL_API_SUBVERSION> equal to their
346C<PERL_SUBVERSION>, explicitly marking them as incompatible with each other.
347
348Maintainance releases of stable perl's will continue to make no intentionally
349incompatible changes.
e90f0e29
DG
350
351=back
352
353=head1 Selected Bug Fixes
354
355XXX Important bug fixes in the core language are summarised here.
356Bug fixes in files in F<ext/> and F<lib/> are best summarised in
357L</Modules and Pragmata>.
358
359[ List each fix as a =item entry ]
360
361=over 4
362
363=item *
364
09d86ea5
FR
365Fixed possible memory leak when using L<caller()|perlfunc/"caller EXPR"> to set
366C<@DB::args>.
367
368=item *
369
370Several memory leaks when loading XS modules were fixed.
e90f0e29
DG
371
372=back
373
374=head1 Known Problems
375
376XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
377tests that had to be C<TODO>ed for the release would be noted here, unless
378they were specific to a particular platform (see below).
379
380This is a list of some significant unfixed bugs, which are regressions
381from either 5.XXX.XXX or 5.XXX.XXX.
382
383[ List each fix as a =item entry ]
384
385=over 4
386
387=item *
388
389XXX
390
391=back
392
393=head1 Obituary
394
395XXX If any significant core contributor has died, we've added a short obituary
396here.
397
398=head1 Acknowledgements
399
400XXX The list of people to thank goes here.
401
402=head1 Reporting Bugs
403
404If you find what you think is a bug, you might check the articles
405recently posted to the comp.lang.perl.misc newsgroup and the perl
406bug database at http://rt.perl.org/perlbug/ . There may also be
407information at http://www.perl.org/ , the Perl Home Page.
408
409If you believe you have an unreported bug, please run the B<perlbug>
410program included with your release. Be sure to trim your bug down
411to a tiny but sufficient test case. Your bug report, along with the
412output of C<perl -V>, will be sent off to perlbug@perl.org to be
413analysed by the Perl porting team.
414
415If the bug you are reporting has security implications, which make it
416inappropriate to send to a publicly archived mailing list, then please send
417it to perl5-security-report@perl.org. This points to a closed subscription
418unarchived mailing list, which includes all the core committers, who be able
419to help assess the impact of issues, figure out a resolution, and help
420co-ordinate the release of patches to mitigate or fix the problem across all
421platforms on which Perl is supported. Please only use this address for
422security issues in the Perl core, not for modules independently
423distributed on CPAN.
424
425=head1 SEE ALSO
426
427The F<Changes> file for an explanation of how to view exhaustive details
428on what changed.
429
430The F<INSTALL> file for how to build Perl.
431
432The F<README> file for general stuff.
433
434The F<Artistic> and F<Copying> files for copyright information.
435
436=cut