This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for e45636ee0875
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 [ this is a template for a new perldelta file.  Any text flagged as XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.21.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.1 release and the 5.21.2
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.0, first read
16 L<perl5211delta>, which describes differences between 5.21.0 and 5.21.1.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head2 Perl is now always compiled with -D_FORTIFY_SOURCE=2 if available
39
40 The 'code hardening' option called C<_FORTIFY_SOURCE>, available in
41 gcc 4.*, is now always used for compiling Perl, if available.
42
43 Note that this isn't necessarily a huge step since in many platforms
44 the step had already been taken several years ago: many Linux
45 distributions (like Fedora) have been using this option for Perl,
46 and OS X has enforced the same for many years.
47
48 =head1 Incompatible Changes
49
50 XXX For a release on a stable branch, this section aspires to be:
51
52     There are no changes intentionally incompatible with 5.XXX.XXX
53     If any exist, they are bugs, and we request that you submit a
54     report.  See L</Reporting Bugs> below.
55
56 [ List each incompatible change as a =head2 entry ]
57
58 =head1 Deprecations
59
60 XXX Any deprecated features, syntax, modules etc. should be listed here.
61
62 =head2 Module removals
63
64 XXX Remove this section if inapplicable.
65
66 The following modules will be removed from the core distribution in a
67 future release, and will at that time need to be installed from CPAN.
68 Distributions on CPAN which require these modules will need to list them as
69 prerequisites.
70
71 The core versions of these modules will now issue C<"deprecated">-category
72 warnings to alert you to this fact.  To silence these deprecation warnings,
73 install the modules in question from CPAN.
74
75 Note that these are (with rare exceptions) fine modules that you are encouraged
76 to continue to use.  Their disinclusion from core primarily hinges on their
77 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
78 not usually on concerns over their design.
79
80 =over
81
82 =item XXX
83
84 XXX Note that deprecated modules should be listed here even if they are listed
85 as an updated module in the L</Modules and Pragmata> section.
86
87 =back
88
89 [ List each other deprecation as a =head2 entry ]
90
91 =head1 Performance Enhancements
92
93 XXX Changes which enhance performance without changing behaviour go here.
94 There may well be none in a stable release.
95
96 [ List each enhancement as a =item entry ]
97
98 =over 4
99
100 =item *
101
102 XXX
103
104 =back
105
106 =head1 Modules and Pragmata
107
108 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
109 go here.  If Module::CoreList is updated, generate an initial draft of the
110 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
111 for important changes should then be added by hand.  In an ideal world,
112 dual-life modules would have a F<Changes> file that could be cribbed.
113
114 [ Within each section, list entries as a =item entry ]
115
116 =head2 New Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 XXX
123
124 =back
125
126 =head2 Updated Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 L<Math::BigInt> has been upgraded from version 1.9995 to 1.9996.
133
134 Correct handling of subclasses.
135 L<[cpan #96254]|https://rt.cpan.org/Ticket/Display.html?id=96254>
136 L<[cpan #96329]|https://rt.cpan.org/Ticket/Display.html?id=96329>
137
138 =item *
139
140 L<Module::CoreList> has been upgraded from version 5.021001_1 to 5.021002.
141
142 =item *
143
144 L<threads> has been upgraded from version 1.94 to 1.95.
145
146 =back
147
148 =head2 Removed Modules and Pragmata
149
150 =over 4
151
152 =item *
153
154 XXX
155
156 =back
157
158 =head1 Documentation
159
160 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
161 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
162
163 =head2 New Documentation
164
165 XXX Changes which create B<new> files in F<pod/> go here.
166
167 =head3 L<XXX>
168
169 XXX Description of the purpose of the new file here
170
171 =head2 Changes to Existing Documentation
172
173 XXX Changes which significantly change existing files in F<pod/> go here.
174 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
175 section.
176
177 =head3 L<XXX>
178
179 =over 4
180
181 =item *
182
183 XXX Description of the change here
184
185 =back
186
187 =head1 Diagnostics
188
189 The following additions or changes have been made to diagnostic output,
190 including warnings and fatal error messages.  For the complete list of
191 diagnostic messages, see L<perldiag>.
192
193 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
194 include any changes in L<perldiag> that reconcile it to the C<C> code.
195
196 =head2 New Diagnostics
197
198 XXX Newly added diagnostic messages go under here, separated into New Errors
199 and New Warnings
200
201 =head3 New Errors
202
203 =over 4
204
205 =item *
206
207 XXX L<message|perldiag/"message">
208
209 =back
210
211 =head3 New Warnings
212
213 =over 4
214
215 =item *
216
217 L<Argument "%s" treated as 0 in increment (++)|perldiag/"Argument "%s" treated
218 as 0 in increment (++)">
219
220 (W numeric) The indicated string was fed as an argument to the C<++> operator
221 which expects either a number or a string matching C</^[a-zA-Z]*[0-9]*\z/>.
222 See L<perlop/Auto-increment and Auto-decrement> for details.
223
224 =back
225
226 =head2 Changes to Existing Diagnostics
227
228 XXX Changes (i.e. rewording) of diagnostic messages go here
229
230 =over 4
231
232 =item *
233
234 XXX Describe change here
235
236 =back
237
238 =head1 Utility Changes
239
240 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
241 Most of these are built within the directory F<utils>.
242
243 [ List utility changes as a =head2 entry for each utility and =item
244 entries for each change
245 Use L<XXX> with program names to get proper documentation linking. ]
246
247 =head2 L<XXX>
248
249 =over 4
250
251 =item *
252
253 XXX
254
255 =back
256
257 =head1 Configuration and Compilation
258
259 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
260 go here.  Any other changes to the Perl build process should be listed here.
261 However, any platform-specific changes should be listed in the
262 L</Platform Support> section, instead.
263
264 [ List changes as a =item entry ].
265
266 =over 4
267
268 =item *
269
270 XXX
271
272 =back
273
274 =head1 Testing
275
276 XXX Any significant changes to the testing of a freshly built perl should be
277 listed here.  Changes which create B<new> files in F<t/> go here as do any
278 large changes to the testing harness (e.g. when parallel testing was added).
279 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
280 that they represent may be covered elsewhere.
281
282 [ List each test improvement as a =item entry ]
283
284 =over 4
285
286 =item *
287
288 XXX
289
290 =back
291
292 =head1 Platform Support
293
294 XXX Any changes to platform support should be listed in the sections below.
295
296 [ Within the sections, list each platform as a =item entry with specific
297 changes as paragraphs below it. ]
298
299 =head2 New Platforms
300
301 XXX List any platforms that this version of perl compiles on, that previous
302 versions did not.  These will either be enabled by new files in the F<hints/>
303 directories, or new subdirectories and F<README> files at the top level of the
304 source tree.
305
306 =over 4
307
308 =item XXX-some-platform
309
310 XXX
311
312 =back
313
314 =head2 Discontinued Platforms
315
316 XXX List any platforms that this version of perl no longer compiles on.
317
318 =over 4
319
320 =item XXX-some-platform
321
322 XXX
323
324 =back
325
326 =head2 Platform-Specific Notes
327
328 XXX List any changes for specific platforms.  This could include configuration
329 and compilation changes or changes in portability/compatibility.  However,
330 changes within modules for platforms should generally be listed in the
331 L</Modules and Pragmata> section.
332
333 =over 4
334
335 =item Solaris
336
337 Builds on Solaris 10 with C<-Dusedtrace> would fail early since make
338 didn't follow implied dependencies to build C<perldtrace.h>.  Added an
339 explicit dependency to C<depend>.
340 L<[perl #120120]|https://rt.perl.org/Ticket/Display.html?id=120120>
341
342 =back
343
344 =head1 Internal Changes
345
346 XXX Changes which affect the interface available to C<XS> code go here.  Other
347 significant internal changes for future core maintainers should be noted as
348 well.
349
350 [ List each change as a =item entry ]
351
352 =over 4
353
354 =item *
355
356 The following private API functions had their context parameter removed,
357 C<Perl_cast_ulong>,  C<Perl_cast_i32>, C<Perl_cast_iv>,    C<Perl_cast_uv>,
358 C<Perl_cv_const_sv>, C<Perl_mg_find>,  C<Perl_mg_findext>, C<Perl_mg_magical>,
359 C<Perl_mini_mktime>, C<Perl_my_dirfd>, C<Perl_sv_backoff>, C<Perl_utf8_hop>.
360
361 Users of the public API prefix-less calls remain unaffected.
362
363 =back
364
365 =head1 Selected Bug Fixes
366
367 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
368 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
369
370 [ List each fix as a =item entry ]
371
372 =over 4
373
374 =item *
375
376 XXX
377
378 =back
379
380 =head1 Known Problems
381
382 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
383 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
384 platform specific bugs also go here.
385
386 [ List each fix as a =item entry ]
387
388 =over 4
389
390 =item *
391
392 XXX
393
394 =back
395
396 =head1 Errata From Previous Releases
397
398 =over 4
399
400 =item *
401
402 XXX Add anything here that we forgot to add, or were mistaken about, in
403 the perldelta of a previous release.
404
405 =back
406
407 =head1 Obituary
408
409 XXX If any significant core contributor has died, we've added a short obituary
410 here.
411
412 =head1 Acknowledgements
413
414 XXX Generate this with:
415
416   perl Porting/acknowledgements.pl v5.21.1..HEAD
417
418 =head1 Reporting Bugs
419
420 If you find what you think is a bug, you might check the articles recently
421 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
422 https://rt.perl.org/ .  There may also be information at
423 http://www.perl.org/ , the Perl Home Page.
424
425 If you believe you have an unreported bug, please run the L<perlbug> program
426 included with your release.  Be sure to trim your bug down to a tiny but
427 sufficient test case.  Your bug report, along with the output of C<perl -V>,
428 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
429
430 If the bug you are reporting has security implications, which make it
431 inappropriate to send to a publicly archived mailing list, then please send it
432 to perl5-security-report@perl.org.  This points to a closed subscription
433 unarchived mailing list, which includes all the core committers, who will be
434 able to help assess the impact of issues, figure out a resolution, and help
435 co-ordinate the release of patches to mitigate or fix the problem across all
436 platforms on which Perl is supported.  Please only use this address for
437 security issues in the Perl core, not for modules independently distributed on
438 CPAN.
439
440 =head1 SEE ALSO
441
442 The F<Changes> file for an explanation of how to view exhaustive details on
443 what changed.
444
445 The F<INSTALL> file for how to build Perl.
446
447 The F<README> file for general stuff.
448
449 The F<Artistic> and F<Copying> files for copyright information.
450
451 =cut