This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #118995] Fix bigrat's $MBI configuration
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
12dcbffb
AP
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.19.3
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
12dcbffb 12This document describes differences between the 5.19.2 release and the 5.19.3
e08634c5 13release.
6db9054f 14
12dcbffb
AP
15If you are upgrading from an earlier release such as 5.19.1, first read
16L<perl5192delta>, which describes differences between 5.19.1 and 5.19.2.
42bff0d9 17
12dcbffb 18=head1 Notice
42bff0d9 19
12dcbffb 20XXX Any important notices here
42bff0d9 21
12dcbffb 22=head1 Core Enhancements
c0ca71c9 23
12dcbffb
AP
24XXX New core language features go here. Summarize user-visible core language
25enhancements. Particularly prominent performance optimisations could go
26here, but most should go in the L</Performance Enhancements> section.
c0ca71c9 27
12dcbffb 28[ List each enhancement as a =head2 entry ]
c0ca71c9 29
5bb43e77
TC
30=head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
31
32Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or
33B<-p> was a no-op, with this change, if you supply B<-F> then both
34B<-a> and B<-n> are implied and if you supply B<-a> then B<-n> is implied.
35
36You can still use B<-p> for its extra behaviour. [perl #116190]
37
12dcbffb 38=head1 Security
c0ca71c9 39
12dcbffb
AP
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.
c0ca71c9 43
12dcbffb 44[ List each security issue as a =head2 entry ]
c0ca71c9 45
12dcbffb 46=head1 Incompatible Changes
c0ca71c9 47
12dcbffb 48XXX For a release on a stable branch, this section aspires to be:
c0ca71c9 49
12dcbffb
AP
50 There are no changes intentionally incompatible with 5.XXX.XXX
51 If any exist, they are bugs, and we request that you submit a
52 report. See L</Reporting Bugs> below.
c0ca71c9 53
12dcbffb 54[ List each incompatible change as a =head2 entry ]
c0ca71c9 55
12dcbffb 56=head1 Deprecations
c0ca71c9 57
12dcbffb 58XXX Any deprecated features, syntax, modules etc. should be listed here.
c0ca71c9 59
12dcbffb 60=head2 Module removals
c0ca71c9 61
12dcbffb 62XXX Remove this section if inapplicable.
c0ca71c9 63
12dcbffb
AP
64The following modules will be removed from the core distribution in a
65future release, and will at that time need to be installed from CPAN.
66Distributions on CPAN which require these modules will need to list them as
67prerequisites.
c0ca71c9 68
12dcbffb
AP
69The core versions of these modules will now issue C<"deprecated">-category
70warnings to alert you to this fact. To silence these deprecation warnings,
71install the modules in question from CPAN.
c0ca71c9 72
12dcbffb
AP
73Note that these are (with rare exceptions) fine modules that you are encouraged
74to continue to use. Their disinclusion from core primarily hinges on their
75necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
76not usually on concerns over their design.
c0ca71c9 77
12dcbffb 78=over
c0ca71c9 79
12dcbffb
AP
80XXX Note that deprecated modules should be listed here even if they are listed
81as an updated module in the L</Modules and Pragmata> section.
c0ca71c9 82
12dcbffb 83=back
c0ca71c9 84
12dcbffb 85[ List each other deprecation as a =head2 entry ]
c0ca71c9 86
12dcbffb 87=head1 Performance Enhancements
c0ca71c9 88
12dcbffb
AP
89XXX Changes which enhance performance without changing behaviour go here.
90There may well be none in a stable release.
c0ca71c9 91
12dcbffb 92[ List each enhancement as a =item entry ]
c0ca71c9 93
12dcbffb 94=over 4
c0ca71c9
AP
95
96=item *
97
12dcbffb 98XXX
c0ca71c9 99
12dcbffb 100=back
70ba8092 101
12dcbffb 102=head1 Modules and Pragmata
42bff0d9 103
12dcbffb
AP
104XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
105go here. If Module::CoreList is updated, generate an initial draft of the
106following sections using F<Porting/corelist-perldelta.pl>, which prints stub
107entries to STDOUT. Results can be pasted in place of the '=head2' entries
108below. A paragraph summary for important changes should then be added by hand.
109In an ideal world, dual-life modules would have a F<Changes> file that could be
110cribbed.
6e4979f3 111
12dcbffb 112[ Within each section, list entries as a =item entry ]
6e4979f3 113
12dcbffb 114=head2 New Modules and Pragmata
6e4979f3 115
12dcbffb 116=over 4
42bff0d9 117
c0ca71c9 118=item *
42bff0d9 119
12dcbffb 120XXX
42bff0d9 121
12dcbffb 122=back
42bff0d9 123
12dcbffb 124=head2 Updated Modules and Pragmata
42bff0d9 125
12dcbffb 126=over 4
42bff0d9 127
c0ca71c9 128=item *
42bff0d9 129
cffd634c
TC
130L<Data::Dumper> has been upgraded from version 2.147 to 2.148.
131
132The compatbility of the XS implementation with the pure perl version
133under C<Useqq> has been improved. [perl #118933]
42bff0d9 134
2cf99697
TC
135=item *
136
137L<Storable> has been upgraded from version 2.45 to 2.46.
138
139Avoid creating temporary objects for STORABLE_attach when they aren't
140required. [perl #118907]
141
c0ca71c9 142=back
42bff0d9 143
12dcbffb 144=head2 Removed Modules and Pragmata
dbd04185 145
38663f11 146=over 4
583aa5c2 147
1fdd5e53
KW
148=item *
149
12dcbffb 150XXX
42bff0d9 151
38663f11 152=back
42bff0d9 153
12dcbffb 154=head1 Documentation
989e4501 155
12dcbffb
AP
156XXX Changes to files in F<pod/> go here. Consider grouping entries by
157file and be sure to link to the appropriate page, e.g. L<perlfunc>.
989e4501 158
12dcbffb 159=head2 New Documentation
989e4501 160
12dcbffb 161XXX Changes which create B<new> files in F<pod/> go here.
42bff0d9 162
12dcbffb 163=head3 L<XXX>
42bff0d9 164
12dcbffb 165XXX Description of the purpose of the new file here
42bff0d9 166
12dcbffb 167=head2 Changes to Existing Documentation
42bff0d9 168
12dcbffb
AP
169XXX Changes which significantly change existing files in F<pod/> go here.
170However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
171section.
42bff0d9 172
3031ec7a 173=head3 L<perlopentut>
42bff0d9 174
38663f11 175=over 4
42bff0d9
DG
176
177=item *
178
3031ec7a
RS
179The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
180focuses on covering only the basics, rather than providing a comprehensive
181reference to all things openable. This rewrite came as the result of a
182vigorous discussion on perl5-porters kicked off by a set of improvements
183written by Alexander Hartmaier to the existing C<perlopentut>. A "more than
184you ever wanted to know about C<open>" document may follow in subsequent
185versions of perl.
1fdd5e53 186
583aa5c2
RS
187=back
188
c0ca71c9
AP
189=head1 Diagnostics
190
191The following additions or changes have been made to diagnostic output,
192including warnings and fatal error messages. For the complete list of
193diagnostic messages, see L<perldiag>.
194
12dcbffb
AP
195XXX New or changed warnings emitted by the core's C<C> code go here. Also
196include any changes in L<perldiag> that reconcile it to the C<C> code.
197
c0ca71c9
AP
198=head2 New Diagnostics
199
12dcbffb
AP
200XXX Newly added diagnostic messages go under here, separated into New Errors
201and New Warnings
202
203=head3 New Errors
583aa5c2 204
38663f11 205=over 4
583aa5c2 206
b8a02ff1 207=item *
583aa5c2 208
12dcbffb 209XXX L<message|perldiag/"message">
583aa5c2 210
b8a02ff1 211=back
583aa5c2 212
12dcbffb 213=head3 New Warnings
96d496e4 214
38663f11 215=over 4
b8a02ff1
DG
216
217=item *
218
12dcbffb 219XXX L<message|perldiag/"message">
96d496e4 220
12dcbffb 221=back
1310e590 222
12dcbffb 223=head2 Changes to Existing Diagnostics
e727f86a 224
12dcbffb 225XXX Changes (i.e. rewording) of diagnostic messages go here
e727f86a 226
12dcbffb 227=over 4
e727f86a 228
81ca6d44
FC
229=item *
230
12dcbffb 231XXX Describe change here
81ca6d44 232
96d496e4
RS
233=back
234
12dcbffb 235=head1 Utility Changes
583aa5c2 236
12dcbffb
AP
237XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
238Most of these are built within the directories F<utils> and F<x2p>.
71e6aba6 239
12dcbffb
AP
240[ List utility changes as a =head3 entry for each utility and =item
241entries for each change
242Use L<XXX> with program names to get proper documentation linking. ]
d5f315e8 243
12dcbffb 244=head3 L<XXX>
e38fc308
NC
245
246=over 4
247
248=item *
249
12dcbffb 250XXX
e38fc308
NC
251
252=back
253
12dcbffb 254=head1 Configuration and Compilation
2426c394 255
12dcbffb
AP
256XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
257go here. Any other changes to the Perl build process should be listed here.
258However, any platform-specific changes should be listed in the
259L</Platform Support> section, instead.
4724da03 260
12dcbffb 261[ List changes as a =item entry ].
583aa5c2 262
38663f11 263=over 4
a34da6c4 264
12dcbffb 265=item *
a34da6c4 266
12dcbffb 267XXX
a34da6c4 268
583aa5c2
RS
269=back
270
12dcbffb 271=head1 Testing
583aa5c2 272
12dcbffb
AP
273XXX Any significant changes to the testing of a freshly built perl should be
274listed here. Changes which create B<new> files in F<t/> go here as do any
275large changes to the testing harness (e.g. when parallel testing was added).
276Changes to existing files in F<t/> aren't worth summarizing, although the bugs
277that they represent may be covered elsewhere.
1de7c8e6 278
12dcbffb 279[ List each test improvement as a =item entry ]
9c800862 280
12dcbffb 281=over 4
aaf54772 282
b7bbd8b6
FC
283=item *
284
12dcbffb 285XXX
b7bbd8b6 286
583aa5c2
RS
287=back
288
12dcbffb 289=head1 Platform Support
d7bfa554 290
12dcbffb 291XXX Any changes to platform support should be listed in the sections below.
81d3ed5a 292
12dcbffb
AP
293[ Within the sections, list each platform as a =item entry with specific
294changes as paragraphs below it. ]
81d3ed5a 295
12dcbffb 296=head2 New Platforms
0b023496 297
12dcbffb
AP
298XXX List any platforms that this version of perl compiles on, that previous
299versions did not. These will either be enabled by new files in the F<hints/>
300directories, or new subdirectories and F<README> files at the top level of the
301source tree.
0b023496 302
12dcbffb 303=over 4
e11f653d 304
12dcbffb 305=item XXX-some-platform
5e0164b2 306
12dcbffb 307XXX
5e0164b2 308
12dcbffb 309=back
e11f653d 310
12dcbffb 311=head2 Discontinued Platforms
8be8cdec 312
12dcbffb 313XXX List any platforms that this version of perl no longer compiles on.
8be8cdec 314
12dcbffb 315=over 4
07a522a5 316
12dcbffb 317=item XXX-some-platform
07a522a5 318
12dcbffb 319XXX
71b4007c 320
12dcbffb 321=back
71b4007c 322
12dcbffb 323=head2 Platform-Specific Notes
f6b1d2f5 324
12dcbffb
AP
325XXX List any changes for specific platforms. This could include configuration
326and compilation changes or changes in portability/compatibility. However,
327changes within modules for platforms should generally be listed in the
328L</Modules and Pragmata> section.
f6b1d2f5 329
12dcbffb 330=over 4
7e4f209b 331
12dcbffb 332=item XXX-some-platform
7e4f209b 333
12dcbffb 334XXX
558673e6 335
12dcbffb 336=back
558673e6 337
12dcbffb 338=head1 Internal Changes
47a7c93d 339
12dcbffb
AP
340XXX Changes which affect the interface available to C<XS> code go here. Other
341significant internal changes for future core maintainers should be noted as
342well.
47a7c93d 343
12dcbffb 344[ List each change as a =item entry ]
b5a80c26 345
12dcbffb 346=over 4
b5a80c26 347
7f1d4316
FC
348=item *
349
12dcbffb 350XXX
7f1d4316 351
12dcbffb 352=back
02bef66e 353
12dcbffb 354=head1 Selected Bug Fixes
d30fb844 355
12dcbffb
AP
356XXX Important bug fixes in the core language are summarized here. Bug fixes in
357files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
d30fb844 358
12dcbffb 359[ List each fix as a =item entry ]
21c01741 360
12dcbffb 361=over 4
21c01741 362
467582e8
FC
363=item *
364
12dcbffb 365XXX
467582e8 366
38663f11 367=back
d7bfa554 368
38663f11 369=head1 Known Problems
6810f0ad 370
12dcbffb
AP
371XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
372tests that had to be C<TODO>ed for the release would be noted here. Unfixed
373platform specific bugs also go here.
374
375[ List each fix as a =item entry ]
376
38663f11 377=over 4
14fd9356
FC
378
379=item *
380
12dcbffb 381XXX
0e417e4d 382
38663f11 383=back
583aa5c2 384
12dcbffb
AP
385=head1 Obituary
386
387XXX If any significant core contributor has died, we've added a short obituary
388here.
389
583aa5c2 390=head1 Acknowledgements
a75569c0 391
12dcbffb
AP
392XXX Generate this with:
393
394 perl Porting/acknowledgements.pl v5.19.2..HEAD
f5b73711 395
44691e6f
AB
396=head1 Reporting Bugs
397
e08634c5
SH
398If you find what you think is a bug, you might check the articles recently
399posted to the comp.lang.perl.misc newsgroup and the perl bug database at
400http://rt.perl.org/perlbug/ . There may also be information at
401http://www.perl.org/ , the Perl Home Page.
44691e6f 402
e08634c5
SH
403If you believe you have an unreported bug, please run the L<perlbug> program
404included with your release. Be sure to trim your bug down to a tiny but
405sufficient test case. Your bug report, along with the output of C<perl -V>,
406will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
407
408If the bug you are reporting has security implications, which make it
e08634c5
SH
409inappropriate to send to a publicly archived mailing list, then please send it
410to perl5-security-report@perl.org. This points to a closed subscription
411unarchived mailing list, which includes all the core committers, who will be
412able to help assess the impact of issues, figure out a resolution, and help
f9001595 413co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
414platforms on which Perl is supported. Please only use this address for
415security issues in the Perl core, not for modules independently distributed on
416CPAN.
44691e6f
AB
417
418=head1 SEE ALSO
419
e08634c5
SH
420The F<Changes> file for an explanation of how to view exhaustive details on
421what changed.
44691e6f
AB
422
423The F<INSTALL> file for how to build Perl.
424
425The F<README> file for general stuff.
426
427The F<Artistic> and F<Copying> files for copyright information.
428
429=cut