This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
90211c0bd774436fed7b7fc1d98b13982b408c85
[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.19.10
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.9 release and the 5.19.10
13 release.
14
15 If you are upgrading from an earlier release such as 5.19.8, first read
16 L<perl5199delta>, which describes differences between 5.19.8 and 5.19.9.
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 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
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.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as a =item entry ]
87
88 =over 4
89
90 =item *
91
92 XXX
93
94 =back
95
96 =head1 Modules and Pragmata
97
98 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99 go here.  If Module::CoreList is updated, generate an initial draft of the
100 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
101 for important changes should then be added by hand.  In an ideal world,
102 dual-life modules would have a F<Changes> file that could be cribbed.
103
104 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<base> has been upgraded from version 2.21 to 2.22.
123
124 Co-exist more gracefully with C<CORE::GLOBAL::require>
125 overrides. [perl #121196]
126
127 =item *
128
129 L<CPAN::Meta> has been upgraded from version 2.133380 to 2.140630.
130
131 Added a C<load_string()> method that guesses whether the string is YAML or JSON.
132
133 =item *
134
135 L<HTTP::Tiny> has been upgraded from version 0.042 to 0.043.
136
137 No longer sends absolute request URI when tunneling SSL via proxy and fixes
138 regression in setting host name to verify SSL.
139
140 =item *
141
142 L<Module::Load> has been upgraded from version 0.30 to 0.32.
143
144 Fix tests to support statically built perls.
145
146 =item *
147
148 L<Parse::CPAN::Meta> has been upgraded from version 1.4413 to 1.4414.
149
150 Added C<load_string>, which uses heuristics to guess YAML/JSON content.
151 C<load_file> will now attempt to detect YAML/JSON content if the suffix is not
152 .json, .yml or .yaml.
153
154 =back
155
156 =head2 Removed Modules and Pragmata
157
158 =over 4
159
160 =item *
161
162 XXX
163
164 =back
165
166 =head1 Documentation
167
168 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
169 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
170
171 =head2 New Documentation
172
173 XXX Changes which create B<new> files in F<pod/> go here.
174
175 =head3 L<XXX>
176
177 XXX Description of the purpose of the new file here
178
179 =head2 Changes to Existing Documentation
180
181 XXX Changes which significantly change existing files in F<pod/> go here.
182 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
183 section.
184
185 =head3 L<XXX>
186
187 =over 4
188
189 =item *
190
191 XXX Description of the change here
192
193 =back
194
195 =head1 Diagnostics
196
197 The following additions or changes have been made to diagnostic output,
198 including warnings and fatal error messages.  For the complete list of
199 diagnostic messages, see L<perldiag>.
200
201 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
202 include any changes in L<perldiag> that reconcile it to the C<C> code.
203
204 =head2 New Diagnostics
205
206 XXX Newly added diagnostic messages go under here, separated into New Errors
207 and New Warnings
208
209 =head3 New Errors
210
211 =over 4
212
213 =item *
214
215 XXX L<message|perldiag/"message">
216
217 =back
218
219 =head3 New Warnings
220
221 =over 4
222
223 =item *
224
225 XXX L<message|perldiag/"message">
226
227 =back
228
229 =head2 Changes to Existing Diagnostics
230
231 XXX Changes (i.e. rewording) of diagnostic messages go here
232
233 =over 4
234
235 =item *
236
237 XXX Describe change here
238
239 =back
240
241 =head1 Utility Changes
242
243 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
244 Most of these are built within the directories F<utils> and F<x2p>.
245
246 [ List utility changes as a =head3 entry for each utility and =item
247 entries for each change
248 Use L<XXX> with program names to get proper documentation linking. ]
249
250 =head3 L<XXX>
251
252 =over 4
253
254 =item *
255
256 XXX
257
258 =back
259
260 =head1 Configuration and Compilation
261
262 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
263 go here.  Any other changes to the Perl build process should be listed here.
264 However, any platform-specific changes should be listed in the
265 L</Platform Support> section, instead.
266
267 [ List changes as a =item entry ].
268
269 =over 4
270
271 =item *
272
273 Where possible, the build now avoids recursive invocations of F<make> when
274 building pure-Perl extensions, without removing any parallelism from the
275 build. Currently around 80 extensions can be processed directly by the
276 F<make_ext.pl> tool, meaning that 80 invocations of F<make> and 160
277 invocations of F<miniperl> are no longer made.
278
279 =back
280
281 =head1 Testing
282
283 XXX Any significant changes to the testing of a freshly built perl should be
284 listed here.  Changes which create B<new> files in F<t/> go here as do any
285 large changes to the testing harness (e.g. when parallel testing was added).
286 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
287 that they represent may be covered elsewhere.
288
289 [ List each test improvement as a =item entry ]
290
291 =over 4
292
293 =item *
294
295 XXX
296
297 =back
298
299 =head1 Platform Support
300
301 XXX Any changes to platform support should be listed in the sections below.
302
303 [ Within the sections, list each platform as a =item entry with specific
304 changes as paragraphs below it. ]
305
306 =head2 New Platforms
307
308 XXX List any platforms that this version of perl compiles on, that previous
309 versions did not.  These will either be enabled by new files in the F<hints/>
310 directories, or new subdirectories and F<README> files at the top level of the
311 source tree.
312
313 =over 4
314
315 =item XXX-some-platform
316
317 XXX
318
319 =back
320
321 =head2 Discontinued Platforms
322
323 XXX List any platforms that this version of perl no longer compiles on.
324
325 =over 4
326
327 =item XXX-some-platform
328
329 XXX
330
331 =back
332
333 =head2 Platform-Specific Notes
334
335 XXX List any changes for specific platforms.  This could include configuration
336 and compilation changes or changes in portability/compatibility.  However,
337 changes within modules for platforms should generally be listed in the
338 L</Modules and Pragmata> section.
339
340 =over 4
341
342 =item XXX-some-platform
343
344 XXX
345
346 =back
347
348 =head1 Internal Changes
349
350 XXX Changes which affect the interface available to C<XS> code go here.  Other
351 significant internal changes for future core maintainers should be noted as
352 well.
353
354 [ List each change as a =item entry ]
355
356 =over 4
357
358 =item *
359
360 XXX
361
362 =back
363
364 =head1 Selected Bug Fixes
365
366 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
367 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
368
369 [ List each fix as a =item entry ]
370
371 =over 4
372
373 =item *
374
375 Static builds, as configured with C<-Uusedl> now build
376 correctly. [perl #121291]
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.18.0..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