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