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