This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 1d5bb6ba43b89
[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
c0ca71c9 135=back
42bff0d9 136
12dcbffb 137=head2 Removed Modules and Pragmata
dbd04185 138
38663f11 139=over 4
583aa5c2 140
1fdd5e53
KW
141=item *
142
12dcbffb 143XXX
42bff0d9 144
38663f11 145=back
42bff0d9 146
12dcbffb 147=head1 Documentation
989e4501 148
12dcbffb
AP
149XXX Changes to files in F<pod/> go here. Consider grouping entries by
150file and be sure to link to the appropriate page, e.g. L<perlfunc>.
989e4501 151
12dcbffb 152=head2 New Documentation
989e4501 153
12dcbffb 154XXX Changes which create B<new> files in F<pod/> go here.
42bff0d9 155
12dcbffb 156=head3 L<XXX>
42bff0d9 157
12dcbffb 158XXX Description of the purpose of the new file here
42bff0d9 159
12dcbffb 160=head2 Changes to Existing Documentation
42bff0d9 161
12dcbffb
AP
162XXX Changes which significantly change existing files in F<pod/> go here.
163However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
164section.
42bff0d9 165
12dcbffb 166=head3 L<XXX>
42bff0d9 167
38663f11 168=over 4
42bff0d9
DG
169
170=item *
171
12dcbffb 172XXX Description of the change here
1fdd5e53 173
583aa5c2
RS
174=back
175
c0ca71c9
AP
176=head1 Diagnostics
177
178The following additions or changes have been made to diagnostic output,
179including warnings and fatal error messages. For the complete list of
180diagnostic messages, see L<perldiag>.
181
12dcbffb
AP
182XXX New or changed warnings emitted by the core's C<C> code go here. Also
183include any changes in L<perldiag> that reconcile it to the C<C> code.
184
c0ca71c9
AP
185=head2 New Diagnostics
186
12dcbffb
AP
187XXX Newly added diagnostic messages go under here, separated into New Errors
188and New Warnings
189
190=head3 New Errors
583aa5c2 191
38663f11 192=over 4
583aa5c2 193
b8a02ff1 194=item *
583aa5c2 195
12dcbffb 196XXX L<message|perldiag/"message">
583aa5c2 197
b8a02ff1 198=back
583aa5c2 199
12dcbffb 200=head3 New Warnings
96d496e4 201
38663f11 202=over 4
b8a02ff1
DG
203
204=item *
205
12dcbffb 206XXX L<message|perldiag/"message">
96d496e4 207
12dcbffb 208=back
1310e590 209
12dcbffb 210=head2 Changes to Existing Diagnostics
e727f86a 211
12dcbffb 212XXX Changes (i.e. rewording) of diagnostic messages go here
e727f86a 213
12dcbffb 214=over 4
e727f86a 215
81ca6d44
FC
216=item *
217
12dcbffb 218XXX Describe change here
81ca6d44 219
96d496e4
RS
220=back
221
12dcbffb 222=head1 Utility Changes
583aa5c2 223
12dcbffb
AP
224XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
225Most of these are built within the directories F<utils> and F<x2p>.
71e6aba6 226
12dcbffb
AP
227[ List utility changes as a =head3 entry for each utility and =item
228entries for each change
229Use L<XXX> with program names to get proper documentation linking. ]
d5f315e8 230
12dcbffb 231=head3 L<XXX>
e38fc308
NC
232
233=over 4
234
235=item *
236
12dcbffb 237XXX
e38fc308
NC
238
239=back
240
12dcbffb 241=head1 Configuration and Compilation
2426c394 242
12dcbffb
AP
243XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244go here. Any other changes to the Perl build process should be listed here.
245However, any platform-specific changes should be listed in the
246L</Platform Support> section, instead.
4724da03 247
12dcbffb 248[ List changes as a =item entry ].
583aa5c2 249
38663f11 250=over 4
a34da6c4 251
12dcbffb 252=item *
a34da6c4 253
12dcbffb 254XXX
a34da6c4 255
583aa5c2
RS
256=back
257
12dcbffb 258=head1 Testing
583aa5c2 259
12dcbffb
AP
260XXX Any significant changes to the testing of a freshly built perl should be
261listed here. Changes which create B<new> files in F<t/> go here as do any
262large changes to the testing harness (e.g. when parallel testing was added).
263Changes to existing files in F<t/> aren't worth summarizing, although the bugs
264that they represent may be covered elsewhere.
1de7c8e6 265
12dcbffb 266[ List each test improvement as a =item entry ]
9c800862 267
12dcbffb 268=over 4
aaf54772 269
b7bbd8b6
FC
270=item *
271
12dcbffb 272XXX
b7bbd8b6 273
583aa5c2
RS
274=back
275
12dcbffb 276=head1 Platform Support
d7bfa554 277
12dcbffb 278XXX Any changes to platform support should be listed in the sections below.
81d3ed5a 279
12dcbffb
AP
280[ Within the sections, list each platform as a =item entry with specific
281changes as paragraphs below it. ]
81d3ed5a 282
12dcbffb 283=head2 New Platforms
0b023496 284
12dcbffb
AP
285XXX List any platforms that this version of perl compiles on, that previous
286versions did not. These will either be enabled by new files in the F<hints/>
287directories, or new subdirectories and F<README> files at the top level of the
288source tree.
0b023496 289
12dcbffb 290=over 4
e11f653d 291
12dcbffb 292=item XXX-some-platform
5e0164b2 293
12dcbffb 294XXX
5e0164b2 295
12dcbffb 296=back
e11f653d 297
12dcbffb 298=head2 Discontinued Platforms
8be8cdec 299
12dcbffb 300XXX List any platforms that this version of perl no longer compiles on.
8be8cdec 301
12dcbffb 302=over 4
07a522a5 303
12dcbffb 304=item XXX-some-platform
07a522a5 305
12dcbffb 306XXX
71b4007c 307
12dcbffb 308=back
71b4007c 309
12dcbffb 310=head2 Platform-Specific Notes
f6b1d2f5 311
12dcbffb
AP
312XXX List any changes for specific platforms. This could include configuration
313and compilation changes or changes in portability/compatibility. However,
314changes within modules for platforms should generally be listed in the
315L</Modules and Pragmata> section.
f6b1d2f5 316
12dcbffb 317=over 4
7e4f209b 318
12dcbffb 319=item XXX-some-platform
7e4f209b 320
12dcbffb 321XXX
558673e6 322
12dcbffb 323=back
558673e6 324
12dcbffb 325=head1 Internal Changes
47a7c93d 326
12dcbffb
AP
327XXX Changes which affect the interface available to C<XS> code go here. Other
328significant internal changes for future core maintainers should be noted as
329well.
47a7c93d 330
12dcbffb 331[ List each change as a =item entry ]
b5a80c26 332
12dcbffb 333=over 4
b5a80c26 334
7f1d4316
FC
335=item *
336
12dcbffb 337XXX
7f1d4316 338
12dcbffb 339=back
02bef66e 340
12dcbffb 341=head1 Selected Bug Fixes
d30fb844 342
12dcbffb
AP
343XXX Important bug fixes in the core language are summarized here. Bug fixes in
344files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
d30fb844 345
12dcbffb 346[ List each fix as a =item entry ]
21c01741 347
12dcbffb 348=over 4
21c01741 349
467582e8
FC
350=item *
351
12dcbffb 352XXX
467582e8 353
38663f11 354=back
d7bfa554 355
38663f11 356=head1 Known Problems
6810f0ad 357
12dcbffb
AP
358XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
359tests that had to be C<TODO>ed for the release would be noted here. Unfixed
360platform specific bugs also go here.
361
362[ List each fix as a =item entry ]
363
38663f11 364=over 4
14fd9356
FC
365
366=item *
367
12dcbffb 368XXX
0e417e4d 369
38663f11 370=back
583aa5c2 371
12dcbffb
AP
372=head1 Obituary
373
374XXX If any significant core contributor has died, we've added a short obituary
375here.
376
583aa5c2 377=head1 Acknowledgements
a75569c0 378
12dcbffb
AP
379XXX Generate this with:
380
381 perl Porting/acknowledgements.pl v5.19.2..HEAD
f5b73711 382
44691e6f
AB
383=head1 Reporting Bugs
384
e08634c5
SH
385If you find what you think is a bug, you might check the articles recently
386posted to the comp.lang.perl.misc newsgroup and the perl bug database at
387http://rt.perl.org/perlbug/ . There may also be information at
388http://www.perl.org/ , the Perl Home Page.
44691e6f 389
e08634c5
SH
390If you believe you have an unreported bug, please run the L<perlbug> program
391included with your release. Be sure to trim your bug down to a tiny but
392sufficient test case. Your bug report, along with the output of C<perl -V>,
393will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
394
395If the bug you are reporting has security implications, which make it
e08634c5
SH
396inappropriate to send to a publicly archived mailing list, then please send it
397to perl5-security-report@perl.org. This points to a closed subscription
398unarchived mailing list, which includes all the core committers, who will be
399able to help assess the impact of issues, figure out a resolution, and help
f9001595 400co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
401platforms on which Perl is supported. Please only use this address for
402security issues in the Perl core, not for modules independently distributed on
403CPAN.
44691e6f
AB
404
405=head1 SEE ALSO
406
e08634c5
SH
407The F<Changes> file for an explanation of how to view exhaustive details on
408what changed.
44691e6f
AB
409
410The F<INSTALL> file for how to build Perl.
411
412The F<README> file for general stuff.
413
414The F<Artistic> and F<Copying> files for copyright information.
415
416=cut