This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add Ivan Pozdeev to AUTHORS
[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
a2373b32
TC
122The PathTools module collection has been upgraded from version 3.55 to
1233.56.
124
125Minor optimizations. [perl #125712]
eabfc7bc 126
cf73ceda
MH
127=back
128
129=head2 Removed Modules and Pragmata
eabfc7bc 130
cf73ceda 131=over 4
eabfc7bc
RS
132
133=item *
134
cf73ceda 135XXX
dc013420 136
cf73ceda 137=back
dc013420 138
cf73ceda 139=head1 Documentation
c85f23b2 140
cf73ceda
MH
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>.
eabfc7bc 143
cf73ceda 144=head2 New Documentation
6962a25d 145
cf73ceda 146XXX Changes which create B<new> files in F<pod/> go here.
f282dc56 147
cf73ceda 148=head3 L<XXX>
f282dc56 149
cf73ceda 150XXX Description of the purpose of the new file here
f282dc56 151
cf73ceda 152=head2 Changes to Existing Documentation
f282dc56 153
cf73ceda
MH
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.
f282dc56 157
cf73ceda 158=head3 L<XXX>
f282dc56 159
cf73ceda 160=over 4
f282dc56
MH
161
162=item *
163
cf73ceda
MH
164XXX Description of the change here
165
166=back
167
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
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
177=head2 New Diagnostics
178
179XXX Newly added diagnostic messages go under here, separated into New Errors
180and New Warnings
181
182=head3 New Errors
183
184=over 4
f282dc56
MH
185
186=item *
187
cf73ceda
MH
188XXX L<message|perldiag/"message">
189
190=back
191
192=head3 New Warnings
193
194=over 4
f282dc56
MH
195
196=item *
197
cf73ceda
MH
198XXX L<message|perldiag/"message">
199
200=back
201
202=head2 Changes to Existing Diagnostics
203
204XXX Changes (i.e. rewording) of diagnostic messages go here
205
206=over 4
6962a25d 207
0b8e4842
SH
208=item *
209
cf73ceda
MH
210XXX Describe change here
211
212=back
213
214=head1 Utility Changes
215
216XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
217Most of these are built within the directory F<utils>.
218
219[ List utility changes as a =head2 entry for each utility and =item
220entries for each change
221Use L<XXX> with program names to get proper documentation linking. ]
222
223=head2 L<XXX>
224
225=over 4
0b8e4842 226
f282dc56 227=item *
eabfc7bc 228
cf73ceda
MH
229XXX
230
231=back
232
233=head1 Configuration and Compilation
234
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.
239
240[ List changes as a =item entry ].
241
242=over 4
374c951f
SH
243
244=item *
245
cf73ceda 246XXX
e586de20 247
fc4c3cec 248=back
e586de20 249
cf73ceda 250=head1 Testing
b7b593d8 251
cf73ceda
MH
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.
b7b593d8 257
cf73ceda 258[ List each test improvement as a =item entry ]
fc4c3cec 259
fc4c3cec 260=over 4
4b951711
TC
261
262=item *
263
cf73ceda 264XXX
eabfc7bc 265
fc4c3cec 266=back
eabfc7bc 267
73d6481e 268=head1 Platform Support
eabfc7bc 269
cf73ceda
MH
270XXX Any changes to platform support should be listed in the sections below.
271
272[ Within the sections, list each platform as a =item entry with specific
273changes as paragraphs below it. ]
274
275=head2 New Platforms
276
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.
9c0328ac 281
fc4c3cec
RS
282=over 4
283
cf73ceda 284=item XXX-some-platform
fc4c3cec 285
cf73ceda 286XXX
7d380357 287
cf73ceda 288=back
7d380357 289
cf73ceda
MH
290=head2 Discontinued Platforms
291
292XXX List any platforms that this version of perl no longer compiles on.
293
294=over 4
295
296=item XXX-some-platform
297
298XXX
7d380357
RS
299
300=back
eabfc7bc 301
cf73ceda
MH
302=head2 Platform-Specific Notes
303
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.
308
309=over 4
310
311=item XXX-some-platform
312
313XXX
314
2cfe9b50 315=back
eabfc7bc 316
fc4c3cec
RS
317=head1 Internal Changes
318
cf73ceda
MH
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.
322
323[ List each change as a =item entry ]
324
2cfe9b50 325=over 4
eabfc7bc
RS
326
327=item *
328
cf73ceda 329XXX
eabfc7bc 330
fc4c3cec 331=back
302ef3d4 332
fc4c3cec 333=head1 Selected Bug Fixes
302ef3d4 334
cf73ceda
MH
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>.
337
338[ List each fix as a =item entry ]
339
fc4c3cec 340=over 4
eabfc7bc 341
73d6481e 342=item *
eabfc7bc 343
912fd711
KW
344Perl can again be compiled with any Unicode version. This used to
345(mostly) work, but was lost in v5.18 through v5.20. The property
346C<Name_Alias> did not exist prior to Unicode 5.0. L<Unicode::UCD>
347incorrectly said it did. This has been fixed.
cf73ceda
MH
348
349=back
350
351=head1 Known Problems
352
353XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
354tests that had to be C<TODO>ed for the release would be noted here. Unfixed
355platform specific bugs also go here.
356
357[ List each fix as a =item entry ]
358
359=over 4
eabfc7bc 360
fc4c3cec 361=item *
2a7a05b4 362
cf73ceda 363XXX
30aa8e3f 364
fc4c3cec 365=back
30aa8e3f 366
cf73ceda 367=head1 Errata From Previous Releases
2a7a05b4 368
cf73ceda 369=over 4
f282dc56 370
cf73ceda 371=item *
f282dc56 372
cf73ceda
MH
373XXX Add anything here that we forgot to add, or were mistaken about, in
374the perldelta of a previous release.
f282dc56 375
cf73ceda 376=back
f282dc56 377
cf73ceda
MH
378=head1 Obituary
379
380XXX If any significant core contributor has died, we've added a short obituary
381here.
382
383=head1 Acknowledgements
f282dc56 384
cf73ceda 385XXX Generate this with:
2cfe9b50 386
cf73ceda 387 perl Porting/acknowledgements.pl v5.23.1..HEAD
f5b73711 388
44691e6f
AB
389=head1 Reporting Bugs
390
e08634c5
SH
391If you find what you think is a bug, you might check the articles recently
392posted to the comp.lang.perl.misc newsgroup and the perl bug database at
fc4c3cec
RS
393L<https://rt.perl.org/> . There may also be information at
394L<http://www.perl.org/> , the Perl Home Page.
44691e6f 395
e08634c5
SH
396If you believe you have an unreported bug, please run the L<perlbug> program
397included with your release. Be sure to trim your bug down to a tiny but
398sufficient test case. Your bug report, along with the output of C<perl -V>,
399will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
400
401If the bug you are reporting has security implications, which make it
e08634c5
SH
402inappropriate to send to a publicly archived mailing list, then please send it
403to perl5-security-report@perl.org. This points to a closed subscription
404unarchived mailing list, which includes all the core committers, who will be
405able to help assess the impact of issues, figure out a resolution, and help
f9001595 406co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
407platforms on which Perl is supported. Please only use this address for
408security issues in the Perl core, not for modules independently distributed on
409CPAN.
44691e6f
AB
410
411=head1 SEE ALSO
412
e08634c5
SH
413The F<Changes> file for an explanation of how to view exhaustive details on
414what changed.
44691e6f
AB
415
416The F<INSTALL> file for how to build Perl.
417
418The F<README> file for general stuff.
419
420The F<Artistic> and F<Copying> files for copyright information.
421
422=cut