This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Upgrade Encode from version 2.75 to 2.76
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
cf73ceda
MH
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.23.2
eabfc7bc 9
2cfe9b50 10=head1 DESCRIPTION
eabfc7bc 11
cf73ceda 12This document describes differences between the 5.23.1 release and the 5.23.2
2cfe9b50 13release.
eabfc7bc 14
cf73ceda
MH
15If you are upgrading from an earlier release such as 5.23.0, first read
16L<perl5231delta>, which describes differences between 5.23.0 and 5.23.1.
17
18=head1 Notice
19
20XXX Any important notices here
fc4c3cec 21
2cfe9b50 22=head1 Core Enhancements
eabfc7bc 23
cf73ceda
MH
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.
deaaea8c 27
cf73ceda 28[ List each enhancement as a =head2 entry ]
deaaea8c 29
cf73ceda 30=head1 Security
deaaea8c 31
cf73ceda
MH
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.
deaaea8c 35
cf73ceda 36[ List each security issue as a =head2 entry ]
deaaea8c 37
cf73ceda 38=head1 Incompatible Changes
deaaea8c 39
cf73ceda 40XXX For a release on a stable branch, this section aspires to be:
fb7e9cdd 41
cf73ceda
MH
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.
fb7e9cdd 45
cf73ceda 46[ List each incompatible change as a =head2 entry ]
deaaea8c 47
cf73ceda 48=head1 Deprecations
7d380357 49
cf73ceda 50XXX Any deprecated features, syntax, modules etc. should be listed here.
7d380357 51
cf73ceda 52=head2 Module removals
0d610ac1 53
cf73ceda 54XXX Remove this section if inapplicable.
0d610ac1 55
cf73ceda
MH
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.
eabfc7bc 60
cf73ceda
MH
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.
26230909 64
cf73ceda
MH
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.
fc4c3cec 69
cf73ceda
MH
70=over
71
72=item XXX
73
74XXX Note that deprecated modules should be listed here even if they are listed
75as an updated module in the L</Modules and Pragmata> section.
76
77=back
78
79[ List each other deprecation as a =head2 entry ]
80
81=head1 Performance Enhancements
82
83XXX Changes which enhance performance without changing behaviour go here.
84There may well be none in a stable release.
85
86[ List each enhancement as a =item entry ]
fc4c3cec 87
f282dc56 88=over 4
fc4c3cec 89
f282dc56 90=item *
fc4c3cec 91
cf73ceda 92XXX
fc4c3cec 93
cf73ceda 94=back
fc4c3cec 95
cf73ceda 96=head1 Modules and Pragmata
fc4c3cec 97
cf73ceda
MH
98XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99go here. If Module::CoreList is updated, generate an initial draft of the
100following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
101for important changes should then be added by hand. In an ideal world,
102dual-life modules would have a F<Changes> file that could be cribbed.
fc4c3cec 103
cf73ceda 104[ Within each section, list entries as a =item entry ]
fc4c3cec 105
cf73ceda 106=head2 New Modules and Pragmata
fc4c3cec 107
cf73ceda 108=over 4
eabfc7bc 109
f282dc56 110=item *
eabfc7bc 111
cf73ceda 112XXX
eabfc7bc 113
cf73ceda 114=back
eabfc7bc 115
cf73ceda
MH
116=head2 Updated Modules and Pragmata
117
118=over 4
eabfc7bc 119
73d6481e 120=item *
eabfc7bc 121
0dd5b0dc
SH
122L<Encode> has been upgraded from version 2.75 to 2.76.
123
124=item *
125
a2373b32
TC
126The PathTools module collection has been upgraded from version 3.55 to
1273.56.
128
129Minor optimizations. [perl #125712]
eabfc7bc 130
cf73ceda
MH
131=back
132
133=head2 Removed Modules and Pragmata
eabfc7bc 134
cf73ceda 135=over 4
eabfc7bc
RS
136
137=item *
138
cf73ceda 139XXX
dc013420 140
cf73ceda 141=back
dc013420 142
cf73ceda 143=head1 Documentation
c85f23b2 144
cf73ceda
MH
145XXX Changes to files in F<pod/> go here. Consider grouping entries by
146file and be sure to link to the appropriate page, e.g. L<perlfunc>.
eabfc7bc 147
cf73ceda 148=head2 New Documentation
6962a25d 149
cf73ceda 150XXX Changes which create B<new> files in F<pod/> go here.
f282dc56 151
cf73ceda 152=head3 L<XXX>
f282dc56 153
cf73ceda 154XXX Description of the purpose of the new file here
f282dc56 155
cf73ceda 156=head2 Changes to Existing Documentation
f282dc56 157
cf73ceda
MH
158XXX Changes which significantly change existing files in F<pod/> go here.
159However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
160section.
f282dc56 161
cf73ceda 162=head3 L<XXX>
f282dc56 163
cf73ceda 164=over 4
f282dc56
MH
165
166=item *
167
cf73ceda
MH
168XXX Description of the change here
169
170=back
171
172=head1 Diagnostics
173
174The following additions or changes have been made to diagnostic output,
175including warnings and fatal error messages. For the complete list of
176diagnostic messages, see L<perldiag>.
177
178XXX New or changed warnings emitted by the core's C<C> code go here. Also
179include any changes in L<perldiag> that reconcile it to the C<C> code.
180
181=head2 New Diagnostics
182
183XXX Newly added diagnostic messages go under here, separated into New Errors
184and New Warnings
185
186=head3 New Errors
187
188=over 4
f282dc56
MH
189
190=item *
191
cf73ceda
MH
192XXX L<message|perldiag/"message">
193
194=back
195
196=head3 New Warnings
197
198=over 4
f282dc56
MH
199
200=item *
201
cf73ceda
MH
202XXX L<message|perldiag/"message">
203
204=back
205
206=head2 Changes to Existing Diagnostics
207
208XXX Changes (i.e. rewording) of diagnostic messages go here
209
210=over 4
6962a25d 211
0b8e4842
SH
212=item *
213
cf73ceda
MH
214XXX Describe change here
215
216=back
217
218=head1 Utility Changes
219
220XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
221Most of these are built within the directory F<utils>.
222
223[ List utility changes as a =head2 entry for each utility and =item
224entries for each change
225Use L<XXX> with program names to get proper documentation linking. ]
226
227=head2 L<XXX>
228
229=over 4
0b8e4842 230
f282dc56 231=item *
eabfc7bc 232
cf73ceda
MH
233XXX
234
235=back
236
237=head1 Configuration and Compilation
238
239XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
240go here. Any other changes to the Perl build process should be listed here.
241However, any platform-specific changes should be listed in the
242L</Platform Support> section, instead.
243
244[ List changes as a =item entry ].
245
246=over 4
374c951f
SH
247
248=item *
249
cf73ceda 250XXX
e586de20 251
fc4c3cec 252=back
e586de20 253
cf73ceda 254=head1 Testing
b7b593d8 255
cf73ceda
MH
256XXX Any significant changes to the testing of a freshly built perl should be
257listed here. Changes which create B<new> files in F<t/> go here as do any
258large changes to the testing harness (e.g. when parallel testing was added).
259Changes to existing files in F<t/> aren't worth summarizing, although the bugs
260that they represent may be covered elsewhere.
b7b593d8 261
cf73ceda 262[ List each test improvement as a =item entry ]
fc4c3cec 263
fc4c3cec 264=over 4
4b951711
TC
265
266=item *
267
cf73ceda 268XXX
eabfc7bc 269
fc4c3cec 270=back
eabfc7bc 271
73d6481e 272=head1 Platform Support
eabfc7bc 273
cf73ceda
MH
274XXX Any changes to platform support should be listed in the sections below.
275
276[ Within the sections, list each platform as a =item entry with specific
277changes as paragraphs below it. ]
278
279=head2 New Platforms
280
281XXX List any platforms that this version of perl compiles on, that previous
282versions did not. These will either be enabled by new files in the F<hints/>
283directories, or new subdirectories and F<README> files at the top level of the
284source tree.
9c0328ac 285
fc4c3cec
RS
286=over 4
287
cf73ceda 288=item XXX-some-platform
fc4c3cec 289
cf73ceda 290XXX
7d380357 291
cf73ceda 292=back
7d380357 293
cf73ceda
MH
294=head2 Discontinued Platforms
295
296XXX List any platforms that this version of perl no longer compiles on.
297
298=over 4
299
300=item XXX-some-platform
301
302XXX
7d380357
RS
303
304=back
eabfc7bc 305
cf73ceda
MH
306=head2 Platform-Specific Notes
307
308XXX List any changes for specific platforms. This could include configuration
309and compilation changes or changes in portability/compatibility. However,
310changes within modules for platforms should generally be listed in the
311L</Modules and Pragmata> section.
312
313=over 4
314
315=item XXX-some-platform
316
317XXX
318
2cfe9b50 319=back
eabfc7bc 320
fc4c3cec
RS
321=head1 Internal Changes
322
cf73ceda
MH
323XXX Changes which affect the interface available to C<XS> code go here. Other
324significant internal changes for future core maintainers should be noted as
325well.
326
327[ List each change as a =item entry ]
328
2cfe9b50 329=over 4
eabfc7bc
RS
330
331=item *
332
cf73ceda 333XXX
eabfc7bc 334
fc4c3cec 335=back
302ef3d4 336
fc4c3cec 337=head1 Selected Bug Fixes
302ef3d4 338
cf73ceda
MH
339XXX Important bug fixes in the core language are summarized here. Bug fixes in
340files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
341
342[ List each fix as a =item entry ]
343
fc4c3cec 344=over 4
eabfc7bc 345
73d6481e 346=item *
eabfc7bc 347
912fd711
KW
348Perl can again be compiled with any Unicode version. This used to
349(mostly) work, but was lost in v5.18 through v5.20. The property
350C<Name_Alias> did not exist prior to Unicode 5.0. L<Unicode::UCD>
351incorrectly said it did. This has been fixed.
cf73ceda
MH
352
353=back
354
355=head1 Known Problems
356
357XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
358tests that had to be C<TODO>ed for the release would be noted here. Unfixed
359platform specific bugs also go here.
360
361[ List each fix as a =item entry ]
362
363=over 4
eabfc7bc 364
fc4c3cec 365=item *
2a7a05b4 366
cf73ceda 367XXX
30aa8e3f 368
fc4c3cec 369=back
30aa8e3f 370
cf73ceda 371=head1 Errata From Previous Releases
2a7a05b4 372
cf73ceda 373=over 4
f282dc56 374
cf73ceda 375=item *
f282dc56 376
cf73ceda
MH
377XXX Add anything here that we forgot to add, or were mistaken about, in
378the perldelta of a previous release.
f282dc56 379
cf73ceda 380=back
f282dc56 381
cf73ceda
MH
382=head1 Obituary
383
384XXX If any significant core contributor has died, we've added a short obituary
385here.
386
387=head1 Acknowledgements
f282dc56 388
cf73ceda 389XXX Generate this with:
2cfe9b50 390
cf73ceda 391 perl Porting/acknowledgements.pl v5.23.1..HEAD
f5b73711 392
44691e6f
AB
393=head1 Reporting Bugs
394
e08634c5
SH
395If you find what you think is a bug, you might check the articles recently
396posted to the comp.lang.perl.misc newsgroup and the perl bug database at
fc4c3cec
RS
397L<https://rt.perl.org/> . There may also be information at
398L<http://www.perl.org/> , the Perl Home Page.
44691e6f 399
e08634c5
SH
400If you believe you have an unreported bug, please run the L<perlbug> program
401included with your release. Be sure to trim your bug down to a tiny but
402sufficient test case. Your bug report, along with the output of C<perl -V>,
403will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
404
405If the bug you are reporting has security implications, which make it
e08634c5
SH
406inappropriate to send to a publicly archived mailing list, then please send it
407to perl5-security-report@perl.org. This points to a closed subscription
408unarchived mailing list, which includes all the core committers, who will be
409able to help assess the impact of issues, figure out a resolution, and help
f9001595 410co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
411platforms on which Perl is supported. Please only use this address for
412security issues in the Perl core, not for modules independently distributed on
413CPAN.
44691e6f
AB
414
415=head1 SEE ALSO
416
e08634c5
SH
417The F<Changes> file for an explanation of how to view exhaustive details on
418what changed.
44691e6f
AB
419
420The F<INSTALL> file for how to build Perl.
421
422The F<README> file for general stuff.
423
424The F<Artistic> and F<Copying> files for copyright information.
425
426=cut