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