This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Expose all GV flags matching qr/GVf_/ as constants in B.
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
4eabcf70
TC
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
417a992d 7
4eabcf70 8perldelta - what is new for perl v5.17.3
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
4eabcf70
TC
12This document describes differences between the 5.17.2 release and
13the 5.17.3 release.
6db9054f 14
4eabcf70
TC
15If you are upgrading from an earlier release such as 5.17.1, first read
16L<perl5172delta>, which describes differences between 5.17.1 and
175.17.2.
ef7131e9 18
4eabcf70 19=head1 Notice
ff3f295c 20
4eabcf70 21XXX Any important notices here
95c6c5c5 22
4eabcf70 23=head1 Core Enhancements
95c6c5c5 24
4eabcf70
TC
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
4c77591b 28
4eabcf70 29[ List each enhancement as a =head2 entry ]
c506fc7e 30
4eabcf70 31=head1 Security
36ab1671 32
4eabcf70
TC
33XXX Any security-related notices go here. In particular, any security
34vulnerabilities closed should be noted here rather than in the
35L</Selected Bug Fixes> section.
36ab1671 36
4eabcf70 37[ List each security issue as a =head2 entry ]
36ab1671 38
4eabcf70 39=head1 Incompatible Changes
df2c1bb8 40
4eabcf70 41XXX For a release on a stable branch, this section aspires to be:
df2c1bb8 42
4eabcf70
TC
43 There are no changes intentionally incompatible with 5.XXX.XXX
44 If any exist, they are bugs, and we request that you submit a
45 report. See L</Reporting Bugs> below.
df2c1bb8 46
4eabcf70 47[ List each incompatible change as a =head2 entry ]
7ab2ea42 48
4eabcf70 49=head1 Deprecations
7ab2ea42 50
4eabcf70
TC
51XXX Any deprecated features, syntax, modules etc. should be listed here.
52In particular, deprecated modules should be listed here even if they are
53listed as an updated module in the L</Modules and Pragmata> section.
7ab2ea42 54
4eabcf70 55[ List each deprecation as a =head2 entry ]
7ab2ea42 56
4eabcf70 57=head1 Performance Enhancements
3be135d8 58
4eabcf70
TC
59XXX Changes which enhance performance without changing behaviour go here. There
60may well be none in a stable release.
3be135d8 61
4eabcf70 62[ List each enhancement as a =item entry ]
6db9054f 63
4eabcf70 64=over 4
6db9054f 65
7ca04d94
TC
66=item *
67
4eabcf70 68XXX
7ca04d94 69
e96e0834 70=back
c506fc7e 71
4eabcf70 72=head1 Modules and Pragmata
95c6c5c5 73
4eabcf70
TC
74XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
75go here. If Module::CoreList is updated, generate an initial draft of the
76following sections using F<Porting/corelist-perldelta.pl>, which prints stub
77entries to STDOUT. Results can be pasted in place of the '=head2' entries
78below. A paragraph summary for important changes should then be added by hand.
79In an ideal world, dual-life modules would have a F<Changes> file that could be
80cribbed.
95c6c5c5 81
4eabcf70
TC
82[ Within each section, list entries as a =item entry ]
83
84=head2 New Modules and Pragmata
95c6c5c5 85
e96e0834 86=over 4
95c6c5c5
JL
87
88=item *
89
4eabcf70 90XXX
95c6c5c5 91
e96e0834 92=back
95c6c5c5 93
4eabcf70 94=head2 Updated Modules and Pragmata
95c6c5c5 95
e96e0834 96=over 4
95c6c5c5 97
95c6c5c5
JL
98=item *
99
4eabcf70 100L<XXX> has been upgraded from version 0.69 to version 0.70.
b8a55fe7 101
e96e0834 102=back
95c6c5c5 103
4eabcf70 104=head2 Removed Modules and Pragmata
95c6c5c5 105
e96e0834 106=over 4
95c6c5c5 107
95c6c5c5
JL
108=item *
109
4eabcf70 110XXX
4f85bc45 111
4eabcf70 112=back
72267260 113
4eabcf70 114=head1 Documentation
72267260 115
4eabcf70
TC
116XXX Changes to files in F<pod/> go here. Consider grouping entries by
117file and be sure to link to the appropriate page, e.g. L<perlfunc>.
4f85bc45 118
4eabcf70 119=head2 New Documentation
7d101ed1 120
4eabcf70 121XXX Changes which create B<new> files in F<pod/> go here.
e013ada0 122
4eabcf70 123=head3 L<XXX>
4f85bc45 124
4eabcf70 125XXX Description of the purpose of the new file here
e013ada0 126
4eabcf70 127=head2 Changes to Existing Documentation
95c6c5c5 128
4eabcf70
TC
129XXX Changes which significantly change existing files in F<pod/> go here.
130However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
131section.
95c6c5c5 132
4eabcf70 133=head3 L<XXX>
95c6c5c5 134
e96e0834 135=over 4
95c6c5c5
JL
136
137=item *
138
4eabcf70 139XXX Description of the change here
95c6c5c5 140
e96e0834 141=back
95c6c5c5 142
4eabcf70 143=head1 Diagnostics
05c8f9ed 144
4eabcf70
TC
145The following additions or changes have been made to diagnostic output,
146including warnings and fatal error messages. For the complete list of
147diagnostic messages, see L<perldiag>.
ceb0881c 148
4eabcf70
TC
149XXX New or changed warnings emitted by the core's C<C> code go here. Also
150include any changes in L<perldiag> that reconcile it to the C<C> code.
0998713f 151
4eabcf70
TC
152[ Within each section, list entries as a =item entry that links to perldiag,
153 e.g.
112b6866 154
4eabcf70 155 =item *
112b6866 156
4eabcf70
TC
157 L<Invalid version object|perldiag/"Invalid version object">
158]
42d72fc5 159
4eabcf70 160=head2 New Diagnostics
42d72fc5 161
4eabcf70 162XXX Newly added diagnostic messages go here
8e125188 163
4eabcf70 164=head3 New Errors
8e125188 165
e96e0834 166=over 4
e128ab2c 167
e2f0c3bb
FC
168=item *
169
4eabcf70 170XXX L<message|perldiag/"message">
16e4fcbf 171
4eabcf70 172=back
e2f0c3bb 173
4eabcf70 174=head3 New Warnings
90519d0f 175
4eabcf70 176=over 4
90519d0f
FC
177
178=item *
179
4eabcf70 180XXX L<message|perldiag/"message">
90519d0f 181
61174fb5 182=back
422287bf 183
4eabcf70
TC
184=head2 Changes to Existing Diagnostics
185
186XXX Changes (i.e. rewording) of diagnostic messages go here
2de6ba8d 187
e128ab2c
DM
188=over 4
189
190=item *
191
4eabcf70 192XXX Describe change here
e128ab2c 193
4eabcf70 194=back
8b1adbab 195
4eabcf70 196=head1 Utility Changes
8b1adbab 197
4eabcf70
TC
198XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
199here. Most of these are built within the directories F<utils> and F<x2p>.
83f29afa 200
4eabcf70
TC
201[ List utility changes as a =head3 entry for each utility and =item
202entries for each change
203Use L<XXX> with program names to get proper documentation linking. ]
83f29afa 204
4eabcf70 205=head3 L<XXX>
0938f143 206
4eabcf70 207=over 4
0938f143 208
72267260
JL
209=item *
210
4eabcf70 211XXX
7a251f7a 212
4eabcf70 213=back
7a251f7a 214
4eabcf70 215=head1 Configuration and Compilation
21247d85 216
4eabcf70
TC
217XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
218go here. Any other changes to the Perl build process should be listed here.
219However, any platform-specific changes should be listed in the
220L</Platform Support> section, instead.
21247d85 221
4eabcf70 222[ List changes as a =item entry ].
2e4f8b82 223
4eabcf70 224=over 4
c95d4104 225
788505db
FC
226=item *
227
4eabcf70 228XXX
788505db 229
4eabcf70 230=back
2c2b9cf4 231
4eabcf70 232=head1 Testing
3cd56aaa 233
4eabcf70
TC
234XXX Any significant changes to the testing of a freshly built perl should be
235listed here. Changes which create B<new> files in F<t/> go here as do any
236large changes to the testing harness (e.g. when parallel testing was added).
237Changes to existing files in F<t/> aren't worth summarising, although the bugs
238that they represent may be covered elsewhere.
3cd56aaa 239
4eabcf70 240[ List each test improvement as a =item entry ]
3cd56aaa 241
4eabcf70 242=over 4
3cd56aaa
TC
243
244=item *
245
4eabcf70 246XXX
3cd56aaa 247
4eabcf70 248=back
3cd56aaa 249
4eabcf70 250=head1 Platform Support
3cd56aaa 251
4eabcf70 252XXX Any changes to platform support should be listed in the sections below.
3cd56aaa 253
4eabcf70
TC
254[ Within the sections, list each platform as a =item entry with specific
255changes as paragraphs below it. ]
3cd56aaa 256
4eabcf70 257=head2 New Platforms
3cd56aaa 258
4eabcf70
TC
259XXX List any platforms that this version of perl compiles on, that previous
260versions did not. These will either be enabled by new files in the F<hints/>
261directories, or new subdirectories and F<README> files at the top level of the
262source tree.
3cd56aaa 263
4eabcf70 264=over 4
3cd56aaa 265
4eabcf70 266=item XXX-some-platform
3cd56aaa 267
4eabcf70 268XXX
c0c19433 269
4eabcf70 270=back
c0c19433 271
4eabcf70 272=head2 Discontinued Platforms
7ab2ea42 273
4eabcf70 274XXX List any platforms that this version of perl no longer compiles on.
7ab2ea42 275
4eabcf70 276=over 4
7ab2ea42 277
4eabcf70 278=item XXX-some-platform
7ab2ea42 279
4eabcf70 280XXX
90519d0f 281
4eabcf70 282=back
90519d0f 283
4eabcf70 284=head2 Platform-Specific Notes
90519d0f 285
4eabcf70
TC
286XXX List any changes for specific platforms. This could include configuration
287and compilation changes or changes in portability/compatibility. However,
288changes within modules for platforms should generally be listed in the
289L</Modules and Pragmata> section.
90519d0f 290
4eabcf70 291=over 4
90519d0f 292
4eabcf70 293=item XXX-some-platform
90519d0f 294
4eabcf70 295XXX
90519d0f 296
4eabcf70 297=back
90519d0f 298
4eabcf70 299=head1 Internal Changes
90519d0f 300
4eabcf70
TC
301XXX Changes which affect the interface available to C<XS> code go here.
302Other significant internal changes for future core maintainers should
303be noted as well.
90519d0f 304
4eabcf70 305[ List each change as a =item entry ]
90519d0f 306
4eabcf70 307=over 4
90519d0f
FC
308
309=item *
310
4eabcf70 311XXX
90519d0f 312
4eabcf70 313=back
90519d0f 314
4eabcf70 315=head1 Selected Bug Fixes
90519d0f 316
4eabcf70
TC
317XXX Important bug fixes in the core language are summarised here.
318Bug fixes in files in F<ext/> and F<lib/> are best summarised in
319L</Modules and Pragmata>.
90519d0f 320
4eabcf70 321[ List each fix as a =item entry ]
90519d0f 322
4eabcf70 323=over 4
90519d0f
FC
324
325=item *
326
4eabcf70 327XXX
90519d0f 328
4eabcf70 329=back
90519d0f 330
4eabcf70 331=head1 Known Problems
b8a55fe7 332
4eabcf70
TC
333XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
334tests that had to be C<TODO>ed for the release would be noted here. Unfixed
335platform specific bugs also go here.
b8a55fe7 336
4eabcf70 337[ List each fix as a =item entry ]
b8a55fe7 338
4eabcf70 339=over 4
b8a55fe7
FC
340
341=item *
342
4eabcf70 343XXX
b8a55fe7 344
4eabcf70 345=back
5073ffbd 346
4eabcf70 347=head1 Obituary
5073ffbd 348
4eabcf70
TC
349XXX If any significant core contributor has died, we've added a short obituary
350here.
e128ab2c 351
61174fb5 352=head1 Acknowledgements
d5dc7001 353
4eabcf70
TC
354XXX Generate this with:
355
356 perl Porting/acknowledgements.pl v5.17.2..HEAD
29cf780c 357
44691e6f
AB
358=head1 Reporting Bugs
359
360If you find what you think is a bug, you might check the articles
52deee2e 361recently posted to the comp.lang.perl.misc newsgroup and the perl
f9001595
RS
362bug database at http://rt.perl.org/perlbug/ . There may also be
363information at http://www.perl.org/ , the Perl Home Page.
44691e6f
AB
364
365If you believe you have an unreported bug, please run the L<perlbug>
52deee2e
DR
366program included with your release. Be sure to trim your bug down
367to a tiny but sufficient test case. Your bug report, along with the
368output of C<perl -V>, will be sent off to perlbug@perl.org to be
369analysed by the Perl porting team.
44691e6f
AB
370
371If the bug you are reporting has security implications, which make it
f9001595
RS
372inappropriate to send to a publicly archived mailing list, then please send
373it to perl5-security-report@perl.org. This points to a closed subscription
374unarchived mailing list, which includes
375all the core committers, who will be able
376to help assess the impact of issues, figure out a resolution, and help
377co-ordinate the release of patches to mitigate or fix the problem across all
378platforms on which Perl is supported. Please only use this address for
379security issues in the Perl core, not for modules independently
380distributed on CPAN.
44691e6f
AB
381
382=head1 SEE ALSO
383
52deee2e
DR
384The F<Changes> file for an explanation of how to view exhaustive details
385on what changed.
44691e6f
AB
386
387The F<INSTALL> file for how to build Perl.
388
389The F<README> file for general stuff.
390
391The F<Artistic> and F<Copying> files for copyright information.
392
393=cut