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