This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for 5afb921fc188
[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 =back
143
144 =head2 Removed Modules and Pragmata
145
146 =over 4
147
148 =item *
149
150 XXX
151
152 =back
153
154 =head1 Documentation
155
156 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
157 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
158
159 =head2 New Documentation
160
161 XXX Changes which create B<new> files in F<pod/> go here.
162
163 =head3 L<XXX>
164
165 XXX Description of the purpose of the new file here
166
167 =head2 Changes to Existing Documentation
168
169 XXX Changes which significantly change existing files in F<pod/> go here.
170 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
171 section.
172
173 =head3 L<XXX>
174
175 =over 4
176
177 =item *
178
179 XXX Description of the change here
180
181 =back
182
183 =head1 Diagnostics
184
185 The following additions or changes have been made to diagnostic output,
186 including warnings and fatal error messages.  For the complete list of
187 diagnostic messages, see L<perldiag>.
188
189 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
190 include any changes in L<perldiag> that reconcile it to the C<C> code.
191
192 =head2 New Diagnostics
193
194 XXX Newly added diagnostic messages go under here, separated into New Errors
195 and New Warnings
196
197 =head3 New Errors
198
199 =over 4
200
201 =item *
202
203 XXX L<message|perldiag/"message">
204
205 =back
206
207 =head3 New Warnings
208
209 =over 4
210
211 =item *
212
213 XXX L<message|perldiag/"message">
214
215 =back
216
217 =head2 Changes to Existing Diagnostics
218
219 XXX Changes (i.e. rewording) of diagnostic messages go here
220
221 =over 4
222
223 =item *
224
225 XXX Describe change here
226
227 =back
228
229 =head1 Utility Changes
230
231 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
232 Most of these are built within the directory F<utils>.
233
234 [ List utility changes as a =head2 entry for each utility and =item
235 entries for each change
236 Use L<XXX> with program names to get proper documentation linking. ]
237
238 =head2 L<XXX>
239
240 =over 4
241
242 =item *
243
244 XXX
245
246 =back
247
248 =head1 Configuration and Compilation
249
250 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
251 go here.  Any other changes to the Perl build process should be listed here.
252 However, any platform-specific changes should be listed in the
253 L</Platform Support> section, instead.
254
255 [ List changes as a =item entry ].
256
257 =over 4
258
259 =item *
260
261 XXX
262
263 =back
264
265 =head1 Testing
266
267 XXX Any significant changes to the testing of a freshly built perl should be
268 listed here.  Changes which create B<new> files in F<t/> go here as do any
269 large changes to the testing harness (e.g. when parallel testing was added).
270 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
271 that they represent may be covered elsewhere.
272
273 [ List each test improvement as a =item entry ]
274
275 =over 4
276
277 =item *
278
279 XXX
280
281 =back
282
283 =head1 Platform Support
284
285 XXX Any changes to platform support should be listed in the sections below.
286
287 [ Within the sections, list each platform as a =item entry with specific
288 changes as paragraphs below it. ]
289
290 =head2 New Platforms
291
292 XXX List any platforms that this version of perl compiles on, that previous
293 versions did not.  These will either be enabled by new files in the F<hints/>
294 directories, or new subdirectories and F<README> files at the top level of the
295 source tree.
296
297 =over 4
298
299 =item XXX-some-platform
300
301 XXX
302
303 =back
304
305 =head2 Discontinued Platforms
306
307 XXX List any platforms that this version of perl no longer compiles on.
308
309 =over 4
310
311 =item XXX-some-platform
312
313 XXX
314
315 =back
316
317 =head2 Platform-Specific Notes
318
319 XXX List any changes for specific platforms.  This could include configuration
320 and compilation changes or changes in portability/compatibility.  However,
321 changes within modules for platforms should generally be listed in the
322 L</Modules and Pragmata> section.
323
324 =over 4
325
326 =item Solaris
327
328 Builds on Solaris 10 with C<-Dusedtrace> would fail early since make
329 didn't follow implied dependencies to build C<perldtrace.h>.  Added an
330 explicit dependency to C<depend>.
331 L<[perl #120120]|https://rt.perl.org/Ticket/Display.html?id=120120>
332
333 =back
334
335 =head1 Internal Changes
336
337 XXX Changes which affect the interface available to C<XS> code go here.  Other
338 significant internal changes for future core maintainers should be noted as
339 well.
340
341 [ List each change as a =item entry ]
342
343 =over 4
344
345 =item *
346
347 The following private API functions had their context parameter removed,
348 C<Perl_cast_ulong>,  C<Perl_cast_i32>, C<Perl_cast_iv>,    C<Perl_cast_uv>,
349 C<Perl_cv_const_sv>, C<Perl_mg_find>,  C<Perl_mg_findext>, C<Perl_mg_magical>,
350 C<Perl_mini_mktime>, C<Perl_my_dirfd>, C<Perl_sv_backoff>, C<Perl_utf8_hop>.
351
352 Users of the public API prefix-less calls remain unaffected.
353
354 =back
355
356 =head1 Selected Bug Fixes
357
358 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
359 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
360
361 [ List each fix as a =item entry ]
362
363 =over 4
364
365 =item *
366
367 XXX
368
369 =back
370
371 =head1 Known Problems
372
373 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
374 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
375 platform specific bugs also go here.
376
377 [ List each fix as a =item entry ]
378
379 =over 4
380
381 =item *
382
383 XXX
384
385 =back
386
387 =head1 Errata From Previous Releases
388
389 =over 4
390
391 =item *
392
393 XXX Add anything here that we forgot to add, or were mistaken about, in
394 the perldelta of a previous release.
395
396 =back
397
398 =head1 Obituary
399
400 XXX If any significant core contributor has died, we've added a short obituary
401 here.
402
403 =head1 Acknowledgements
404
405 XXX Generate this with:
406
407   perl Porting/acknowledgements.pl v5.21.1..HEAD
408
409 =head1 Reporting Bugs
410
411 If you find what you think is a bug, you might check the articles recently
412 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
413 https://rt.perl.org/ .  There may also be information at
414 http://www.perl.org/ , the Perl Home Page.
415
416 If you believe you have an unreported bug, please run the L<perlbug> program
417 included with your release.  Be sure to trim your bug down to a tiny but
418 sufficient test case.  Your bug report, along with the output of C<perl -V>,
419 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
420
421 If the bug you are reporting has security implications, which make it
422 inappropriate to send to a publicly archived mailing list, then please send it
423 to perl5-security-report@perl.org.  This points to a closed subscription
424 unarchived mailing list, which includes all the core committers, who will be
425 able to help assess the impact of issues, figure out a resolution, and help
426 co-ordinate the release of patches to mitigate or fix the problem across all
427 platforms on which Perl is supported.  Please only use this address for
428 security issues in the Perl core, not for modules independently distributed on
429 CPAN.
430
431 =head1 SEE ALSO
432
433 The F<Changes> file for an explanation of how to view exhaustive details on
434 what changed.
435
436 The F<INSTALL> file for how to build Perl.
437
438 The F<README> file for general stuff.
439
440 The F<Artistic> and F<Copying> files for copyright information.
441
442 =cut