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