This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade PathTools from version 3.31_02 to 3.32
[perl5.git] / pod / perldelta.pod
CommitLineData
4c793fe3
FR
1=encoding utf8
2
3=head1 NAME
4
ee0887a9
SH
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
4c793fe3 7
ee0887a9 8perldelta - what is new for perl v5.13.6
4c793fe3 9
ee0887a9 10=head1 DESCRIPTION
0c692eed 11
ee0887a9
SH
12This document describes differences between the 5.13.5 release and
13the 5.13.6 release.
0c692eed 14
ee0887a9
SH
15If you are upgrading from an earlier release such as 5.13.4, first read
16L<perl5135delta>, which describes differences between 5.13.4 and
175.13.5.
0c692eed 18
ee0887a9 19=head1 Notice
0c692eed 20
ee0887a9 21XXX Any important notices here
4c793fe3 22
ee0887a9 23=head1 Core Enhancements
85318b69 24
ee0887a9
SH
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
85318b69 28
ee0887a9 29[ List each enhancement as a =head2 entry ]
85318b69 30
ee0887a9 31=head1 Security
85318b69 32
ee0887a9
SH
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
85318b69 36
ee0887a9 37[ List each security issue as a =head2 entry ]
4c793fe3
FR
38
39=head1 Incompatible Changes
40
ee0887a9 41XXX For a release on a stable branch, this section aspires to be:
44428a46 42
ee0887a9
SH
43 There are no changes intentionally incompatible with 5.XXX.XXX. If any
44 exist, they are bugs and reports are welcome.
44428a46 45
ee0887a9 46[ List each incompatible change as a =head2 entry ]
4c793fe3
FR
47
48=head1 Deprecations
49
ee0887a9
SH
50XXX Any deprecated features, syntax, modules etc. should be listed here.
51In particular, deprecated modules should be listed here even if they are
52listed as an updated module in the L</Modules and Pragmata> section.
85318b69 53
ee0887a9 54[ List each deprecation as a =head2 entry ]
4c793fe3
FR
55
56=head1 Performance Enhancements
57
ee0887a9
SH
58XXX Changes which enhance performance without changing behaviour go here. There
59may well be none in a stable release.
4c793fe3 60
ee0887a9 61[ List each enhancement as a =item entry ]
4c793fe3 62
ee0887a9 63=over 4
4c793fe3 64
e2babdfb
FR
65=item *
66
ee0887a9 67XXX
e2babdfb 68
4c793fe3
FR
69=back
70
71=head1 Modules and Pragmata
72
ee0887a9
SH
73XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74go here. If Module::CoreList is updated, generate an initial draft of the
75following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76entries to STDOUT. Results can be pasted in place of the '=head2' entries
77below. A paragraph summary for important changes should then be added by hand.
78In an ideal world, dual-life modules would have a F<Changes> file that could be
79cribbed.
fc1418b7 80
ee0887a9 81[ Within each section, list entries as a =item entry ]
df91fef1 82
ee0887a9 83=head2 New Modules and Pragmata
ccb45ef4 84
ee0887a9 85=over 4
df91fef1 86
ee0887a9 87=item *
df91fef1 88
ee0887a9 89XXX
e2babdfb 90
ee0887a9 91=back
e2babdfb 92
ee0887a9 93=head2 Updated Modules and Pragmata
fc1418b7 94
ee0887a9 95=over 4
fc1418b7 96
ee0887a9 97=item *
e2babdfb 98
8e58c70c 99C<PathTools> has been upgraded from version 3.31_01 to 3.32.
c9a84c8b 100
ee0887a9 101=back
c9a84c8b 102
ee0887a9 103=head2 Removed Modules and Pragmata
c9a84c8b 104
ee0887a9 105=over 4
4c793fe3 106
ee0887a9 107=item *
48c1efd2 108
ee0887a9 109XXX
4c793fe3
FR
110
111=back
112
113=head1 Documentation
114
ee0887a9
SH
115XXX Changes to files in F<pod/> go here. Consider grouping entries by
116file and be sure to link to the appropriate page, e.g. L<perlfunc>.
4c793fe3 117
ee0887a9 118=head2 New Documentation
4c793fe3 119
ee0887a9 120XXX Changes which create B<new> files in F<pod/> go here.
4c793fe3 121
ee0887a9 122=head3 L<XXX>
4c793fe3 123
ee0887a9 124XXX Description of the purpose of the new file here
4c793fe3 125
ee0887a9 126=head2 Changes to Existing Documentation
fc1418b7 127
ee0887a9
SH
128XXX Changes which significantly change existing files in F<pod/> go here.
129However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
130section.
fc1418b7 131
ee0887a9 132=head3 L<XXX>
e2babdfb 133
7bc3efda
SH
134=over 4
135
136=item *
137
ee0887a9 138XXX Description of the change here
7bc3efda
SH
139
140=back
e2babdfb 141
4c793fe3
FR
142=head1 Diagnostics
143
144The following additions or changes have been made to diagnostic output,
145including warnings and fatal error messages. For the complete list of
146diagnostic messages, see L<perldiag>.
147
ee0887a9
SH
148XXX New or changed warnings emitted by the core's C<C> code go here. Also
149include any changes in L<perldiag> that reconcile it to the C<C> code.
4c793fe3 150
ee0887a9 151[ Within each section, list entries as a =item entry ]
4c793fe3 152
ee0887a9 153=head2 New Diagnostics
4c793fe3 154
ee0887a9 155XXX Newly added diagnostic messages go here
fc1418b7 156
ee0887a9 157=over 4
fc1418b7
SH
158
159=item *
160
ee0887a9 161XXX
ebce6c40 162
4c793fe3
FR
163=back
164
ee0887a9 165=head2 Changes to Existing Diagnostics
4c793fe3 166
ee0887a9 167XXX Changes (i.e. rewording) of diagnostic messages go here
4c793fe3
FR
168
169=over 4
170
171=item *
172
ee0887a9 173XXX
4c793fe3
FR
174
175=back
176
ee0887a9 177=head1 Utility Changes
4c793fe3 178
ee0887a9
SH
179XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
180here. Most of these are built within the directories F<utils> and F<x2p>.
4c793fe3 181
ee0887a9
SH
182[ List utility changes as a =head3 entry for each utility and =item
183entries for each change
184Use L<XXX> with program names to get proper documentation linking. ]
fc1418b7 185
ee0887a9 186=head3 L<XXX>
fc1418b7 187
ee0887a9 188=over 4
4c793fe3 189
44428a46
FC
190=item *
191
ee0887a9 192XXX
44428a46 193
4c793fe3
FR
194=back
195
ee0887a9 196=head1 Configuration and Compilation
4c793fe3 197
ee0887a9
SH
198XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
199go here. Any other changes to the Perl build process should be listed here.
200However, any platform-specific changes should be listed in the
201L</Platform Support> section, instead.
4c793fe3 202
ee0887a9 203[ List changes as a =item entry ].
4c793fe3 204
0c692eed
FR
205=over 4
206
207=item *
208
ee0887a9 209XXX
0c692eed
FR
210
211=back
4c793fe3 212
ee0887a9 213=head1 Testing
0c692eed 214
ee0887a9
SH
215XXX Any significant changes to the testing of a freshly built perl should be
216listed here. Changes which create B<new> files in F<t/> go here as do any
217large changes to the testing harness (e.g. when parallel testing was added).
218Changes to existing files in F<t/> aren't worth summarising, although the bugs
219that they represent may be covered elsewhere.
0c692eed 220
ee0887a9 221[ List each test improvement as a =item entry ]
0c692eed 222
ee0887a9 223=over 4
0c692eed
FR
224
225=item *
226
ee0887a9 227XXX
4c793fe3
FR
228
229=back
230
ee0887a9 231=head1 Platform Support
4c793fe3 232
ee0887a9 233XXX Any changes to platform support should be listed in the sections below.
4c793fe3 234
ee0887a9
SH
235[ Within the sections, list each platform as a =item entry with specific
236changes as paragraphs below it. ]
4c793fe3 237
ee0887a9 238=head2 New Platforms
0c692eed 239
ee0887a9
SH
240XXX List any platforms that this version of perl compiles on, that previous
241versions did not. These will either be enabled by new files in the F<hints/>
242directories, or new subdirectories and F<README> files at the top level of the
243source tree.
0c692eed 244
ee0887a9 245=over 4
0c692eed 246
ee0887a9 247=item XXX-some-platform
0c692eed 248
ee0887a9 249XXX
0c692eed 250
ee0887a9 251=back
0c692eed 252
ee0887a9 253=head2 Discontinued Platforms
4c793fe3 254
ee0887a9 255XXX List any platforms that this version of perl no longer compiles on.
8ebb9810 256
ee0887a9 257=over 4
8ebb9810 258
ee0887a9 259=item XXX-some-platform
48c1efd2 260
ee0887a9 261XXX
48c1efd2 262
ee0887a9 263=back
44428a46 264
ee0887a9 265=head2 Platform-Specific Notes
44428a46 266
ee0887a9
SH
267XXX List any changes for specific platforms. This could include configuration
268and compilation changes or changes in portability/compatibility. However,
269changes within modules for platforms should generally be listed in the
270L</Modules and Pragmata> section.
f4beb78f 271
ee0887a9 272=over 4
f4beb78f 273
ee0887a9 274=item XXX-some-platform
ccb45ef4 275
ee0887a9 276XXX
ccb45ef4 277
ee0887a9 278=back
85318b69 279
ee0887a9 280=head1 Internal Changes
85318b69 281
ee0887a9
SH
282XXX Changes which affect the interface available to C<XS> code go here.
283Other significant internal changes for future core maintainers should
284be noted as well.
85318b69 285
ee0887a9 286[ List each test improvement as a =item entry ]
80b6a949 287
ee0887a9 288=over 4
80b6a949 289
e2babdfb
FR
290=item *
291
ee0887a9 292XXX
e2babdfb 293
ee0887a9 294=back
e2babdfb 295
ee0887a9 296=head1 Selected Bug Fixes
e2babdfb 297
ee0887a9
SH
298XXX Important bug fixes in the core language are summarised here.
299Bug fixes in files in F<ext/> and F<lib/> are best summarised in
300L</Modules and Pragmata>.
e2babdfb 301
ee0887a9 302[ List each fix as a =item entry ]
346e4e56 303
ee0887a9 304=over 4
346e4e56 305
78846812
FR
306=item *
307
ee0887a9 308XXX
78846812 309
4c793fe3
FR
310=back
311
962fbe1d
SH
312=head1 Known Problems
313
ee0887a9
SH
314XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
315tests that had to be C<TODO>ed for the release would be noted here, unless
316they were specific to a particular platform (see below).
962fbe1d 317
ee0887a9
SH
318This is a list of some significant unfixed bugs, which are regressions
319from either 5.XXX.XXX or 5.XXX.XXX.
962fbe1d 320
ee0887a9
SH
321[ List each fix as a =item entry ]
322
323=over 4
08d032c0
SH
324
325=item *
326
ee0887a9 327XXX
962fbe1d
SH
328
329=back
330
ee0887a9 331=head1 Obituary
4c793fe3 332
ee0887a9
SH
333XXX If any significant core contributor has died, we've added a short obituary
334here.
0195fb5f 335
ee0887a9 336=head1 Acknowledgements
0195fb5f 337
ee0887a9 338XXX The list of people to thank goes here.
4c793fe3
FR
339
340=head1 Reporting Bugs
341
342If you find what you think is a bug, you might check the articles
343recently posted to the comp.lang.perl.misc newsgroup and the perl
344bug database at http://rt.perl.org/perlbug/ . There may also be
345information at http://www.perl.org/ , the Perl Home Page.
346
347If you believe you have an unreported bug, please run the B<perlbug>
348program included with your release. Be sure to trim your bug down
349to a tiny but sufficient test case. Your bug report, along with the
350output of C<perl -V>, will be sent off to perlbug@perl.org to be
351analysed by the Perl porting team.
352
353If the bug you are reporting has security implications, which make it
354inappropriate to send to a publicly archived mailing list, then please send
ee0887a9 355it to perl5-security-report@perl.org. This points to a closed subscription
4c793fe3
FR
356unarchived mailing list, which includes all the core committers, who be able
357to help assess the impact of issues, figure out a resolution, and help
358co-ordinate the release of patches to mitigate or fix the problem across all
ee0887a9 359platforms on which Perl is supported. Please only use this address for
4c793fe3
FR
360security issues in the Perl core, not for modules independently
361distributed on CPAN.
362
363=head1 SEE ALSO
364
365The F<Changes> file for an explanation of how to view exhaustive details
366on what changed.
367
368The F<INSTALL> file for how to build Perl.
369
370The F<README> file for general stuff.
371
372The F<Artistic> and F<Copying> files for copyright information.
373
374=cut