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