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