Commit | Line | Data |
---|---|---|
e111cbd4 FC |
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.20.0 | |
9 | ||
10 | =head1 DESCRIPTION | |
11 | ||
12 | This document describes differences between the 5.18.0 release and the | |
13 | 5.20.0 release. | |
14 | ||
15 | If you are upgrading from an earlier release such as 5.16.0, first read | |
16 | L<perl5180delta>, which describes differences between 5.16.0 and 5.18.0. | |
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 | ||
37ea023e DM |
50 | The C</\C/> regular expression character class is deprecated. From perl |
51 | 5.22 onwards it will generate a warning, and from perl 5.24 onwards it | |
1ffb44d6 DM |
52 | be a regular expression compiler error. If you need to examine the |
53 | individual bytes that make up a UTF8-encoded character, then use | |
37ea023e | 54 | C<utf8::encode()> on the string (or a copy) first. |
e111cbd4 FC |
55 | |
56 | =head2 Module removals | |
57 | ||
58 | XXX Remove this section if inapplicable. | |
59 | ||
60 | The following modules will be removed from the core distribution in a | |
61 | future release, and will at that time need to be installed from CPAN. | |
62 | Distributions on CPAN which require these modules will need to list them as | |
63 | prerequisites. | |
64 | ||
65 | The core versions of these modules will now issue C<"deprecated">-category | |
66 | warnings to alert you to this fact. To silence these deprecation warnings, | |
67 | install the modules in question from CPAN. | |
68 | ||
69 | Note that these are (with rare exceptions) fine modules that you are encouraged | |
70 | to continue to use. Their disinclusion from core primarily hinges on their | |
71 | necessity to bootstrapping a fully functional, CPAN-capable Perl installation, | |
72 | not usually on concerns over their design. | |
73 | ||
74 | =over | |
75 | ||
76 | XXX Note that deprecated modules should be listed here even if they are listed | |
77 | as an updated module in the L</Modules and Pragmata> section. | |
78 | ||
79 | =back | |
80 | ||
81 | [ List each other deprecation as a =head2 entry ] | |
82 | ||
83 | =head1 Performance Enhancements | |
84 | ||
85 | XXX Changes which enhance performance without changing behaviour go here. | |
86 | There may well be none in a stable release. | |
87 | ||
88 | [ List each enhancement as a =item entry ] | |
89 | ||
90 | =over 4 | |
91 | ||
92 | =item * | |
93 | ||
94 | XXX | |
95 | ||
96 | =back | |
97 | ||
98 | =head1 Modules and Pragmata | |
99 | ||
100 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> | |
101 | go here. If Module::CoreList is updated, generate an initial draft of the | |
2c5d738b SH |
102 | following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary |
103 | for important changes should then be added by hand. In an ideal world, | |
104 | dual-life modules would have a F<Changes> file that could be cribbed. | |
e111cbd4 FC |
105 | |
106 | [ Within each section, list entries as a =item entry ] | |
107 | ||
108 | =head2 New Modules and Pragmata | |
109 | ||
110 | =over 4 | |
111 | ||
112 | =item * | |
113 | ||
114 | XXX | |
115 | ||
116 | =back | |
117 | ||
118 | =head2 Updated Modules and Pragmata | |
119 | ||
120 | =over 4 | |
121 | ||
122 | =item * | |
123 | ||
124 | L<XXX> has been upgraded from version A.xx to B.yy. | |
125 | ||
126 | =back | |
127 | ||
128 | =head2 Removed Modules and Pragmata | |
129 | ||
130 | =over 4 | |
131 | ||
132 | =item * | |
133 | ||
134 | XXX | |
135 | ||
136 | =back | |
137 | ||
138 | =head1 Documentation | |
139 | ||
140 | XXX Changes to files in F<pod/> go here. Consider grouping entries by | |
141 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
142 | ||
143 | =head2 New Documentation | |
144 | ||
145 | XXX Changes which create B<new> files in F<pod/> go here. | |
146 | ||
147 | =head3 L<XXX> | |
148 | ||
149 | XXX Description of the purpose of the new file here | |
150 | ||
151 | =head2 Changes to Existing Documentation | |
152 | ||
153 | XXX Changes which significantly change existing files in F<pod/> go here. | |
154 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
155 | section. | |
156 | ||
157 | =head3 L<XXX> | |
158 | ||
159 | =over 4 | |
160 | ||
161 | =item * | |
162 | ||
163 | XXX Description of the change here | |
164 | ||
165 | =back | |
166 | ||
167 | =head1 Diagnostics | |
168 | ||
169 | The following additions or changes have been made to diagnostic output, | |
170 | including warnings and fatal error messages. For the complete list of | |
171 | diagnostic messages, see L<perldiag>. | |
172 | ||
173 | XXX New or changed warnings emitted by the core's C<C> code go here. Also | |
174 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
175 | ||
176 | =head2 New Diagnostics | |
177 | ||
178 | XXX Newly added diagnostic messages go under here, separated into New Errors | |
179 | and New Warnings | |
180 | ||
181 | =head3 New Errors | |
182 | ||
183 | =over 4 | |
184 | ||
185 | =item * | |
186 | ||
187 | XXX L<message|perldiag/"message"> | |
188 | ||
189 | =back | |
190 | ||
191 | =head3 New Warnings | |
192 | ||
193 | =over 4 | |
194 | ||
195 | =item * | |
196 | ||
197 | XXX L<message|perldiag/"message"> | |
198 | ||
199 | =back | |
200 | ||
201 | =head2 Changes to Existing Diagnostics | |
202 | ||
203 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
204 | ||
205 | =over 4 | |
206 | ||
207 | =item * | |
208 | ||
209 | XXX Describe change here | |
210 | ||
211 | =back | |
212 | ||
213 | =head1 Utility Changes | |
214 | ||
215 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
216 | Most of these are built within the directories F<utils> and F<x2p>. | |
217 | ||
218 | [ List utility changes as a =head3 entry for each utility and =item | |
219 | entries for each change | |
220 | Use L<XXX> with program names to get proper documentation linking. ] | |
221 | ||
222 | =head3 L<XXX> | |
223 | ||
224 | =over 4 | |
225 | ||
226 | =item * | |
227 | ||
228 | XXX | |
229 | ||
230 | =back | |
231 | ||
232 | =head1 Configuration and Compilation | |
233 | ||
234 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
235 | go here. Any other changes to the Perl build process should be listed here. | |
236 | However, any platform-specific changes should be listed in the | |
237 | L</Platform Support> section, instead. | |
238 | ||
239 | [ List changes as a =item entry ]. | |
240 | ||
241 | =over 4 | |
242 | ||
243 | =item * | |
244 | ||
245 | XXX | |
246 | ||
247 | =back | |
248 | ||
249 | =head1 Testing | |
250 | ||
251 | XXX Any significant changes to the testing of a freshly built perl should be | |
252 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
253 | large changes to the testing harness (e.g. when parallel testing was added). | |
254 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
255 | that they represent may be covered elsewhere. | |
256 | ||
257 | [ List each test improvement as a =item entry ] | |
258 | ||
259 | =over 4 | |
260 | ||
261 | =item * | |
262 | ||
263 | XXX | |
264 | ||
265 | =back | |
266 | ||
267 | =head1 Platform Support | |
268 | ||
269 | XXX Any changes to platform support should be listed in the sections below. | |
270 | ||
271 | [ Within the sections, list each platform as a =item entry with specific | |
272 | changes as paragraphs below it. ] | |
273 | ||
274 | =head2 New Platforms | |
275 | ||
276 | XXX List any platforms that this version of perl compiles on, that previous | |
277 | versions did not. These will either be enabled by new files in the F<hints/> | |
278 | directories, or new subdirectories and F<README> files at the top level of the | |
279 | source tree. | |
280 | ||
281 | =over 4 | |
282 | ||
283 | =item XXX-some-platform | |
284 | ||
285 | XXX | |
286 | ||
287 | =back | |
288 | ||
289 | =head2 Discontinued Platforms | |
290 | ||
291 | XXX List any platforms that this version of perl no longer compiles on. | |
292 | ||
293 | =over 4 | |
294 | ||
295 | =item XXX-some-platform | |
296 | ||
297 | XXX | |
298 | ||
299 | =back | |
300 | ||
301 | =head2 Platform-Specific Notes | |
302 | ||
303 | XXX List any changes for specific platforms. This could include configuration | |
304 | and compilation changes or changes in portability/compatibility. However, | |
305 | changes within modules for platforms should generally be listed in the | |
306 | L</Modules and Pragmata> section. | |
307 | ||
308 | =over 4 | |
309 | ||
310 | =item XXX-some-platform | |
311 | ||
312 | XXX | |
313 | ||
314 | =back | |
315 | ||
316 | =head1 Internal Changes | |
317 | ||
318 | XXX Changes which affect the interface available to C<XS> code go here. Other | |
319 | significant internal changes for future core maintainers should be noted as | |
320 | well. | |
321 | ||
322 | [ List each change as a =item entry ] | |
323 | ||
324 | =over 4 | |
325 | ||
326 | =item * | |
327 | ||
328 | XXX | |
329 | ||
330 | =back | |
331 | ||
332 | =head1 Selected Bug Fixes | |
333 | ||
334 | XXX Important bug fixes in the core language are summarized here. Bug fixes in | |
335 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
336 | ||
337 | [ List each fix as a =item entry ] | |
338 | ||
339 | =over 4 | |
340 | ||
341 | =item * | |
342 | ||
343 | XXX | |
344 | ||
345 | =back | |
346 | ||
347 | =head1 Known Problems | |
348 | ||
349 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any | |
350 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
351 | platform specific bugs also go here. | |
352 | ||
353 | [ List each fix as a =item entry ] | |
354 | ||
355 | =over 4 | |
356 | ||
357 | =item * | |
358 | ||
508d2c0a FC |
359 | The following modules are known to have test failures with this version of |
360 | Perl. Patches have been submitted, so there will hopefully be new releases | |
361 | soon: | |
362 | ||
363 | XXX Go through this list just before the release of 5.20 and remove any | |
364 | modules that have been fixed. | |
365 | ||
366 | =over | |
367 | ||
368 | =item * | |
55c1cada | 369 | |
5d92b2b4 FC |
370 | L<Data::Structure::Util> version 0.15 |
371 | ||
372 | =item * | |
373 | ||
374 | L<Data::Util> version 0.62 | |
375 | ||
376 | =item * | |
377 | ||
67fc615f FC |
378 | L<HTML::FormHandler>. The test failures are actually due to a bug in |
379 | L<Data::Clone> version 0.003. A patch to Data::Clone has been submitted. | |
380 | ||
381 | =item * | |
382 | ||
55c1cada | 383 | L<HTML::StripScripts> version 1.05 |
508d2c0a FC |
384 | |
385 | =item * | |
386 | ||
387 | L<LaTeX::Encode> version 0.08 | |
388 | ||
389 | =item | |
390 | ||
a580c898 | 391 | L<Mail::SpamAssassin> version 3.3.2 |
508d2c0a | 392 | |
1a859894 FC |
393 | =item * |
394 | ||
395 | L<RDF::Trine>. The test failures are actually due to a bug in | |
396 | L<XML::LibXML> version 2.0108. A patch to XML::LibXML has been submitted. | |
397 | ||
508d2c0a | 398 | =back |
e111cbd4 FC |
399 | |
400 | =back | |
401 | ||
402 | =head1 Obituary | |
403 | ||
404 | XXX If any significant core contributor has died, we've added a short obituary | |
405 | here. | |
406 | ||
407 | =head1 Acknowledgements | |
408 | ||
409 | XXX Generate this with: | |
410 | ||
d7e76b03 | 411 | perl Porting/acknowledgements.pl v5.19.11..HEAD |
e111cbd4 FC |
412 | |
413 | =head1 Reporting Bugs | |
414 | ||
415 | If you find what you think is a bug, you might check the articles recently | |
416 | posted to the comp.lang.perl.misc newsgroup and the perl bug database at | |
417 | http://rt.perl.org/perlbug/ . There may also be information at | |
418 | http://www.perl.org/ , the Perl Home Page. | |
419 | ||
420 | If you believe you have an unreported bug, please run the L<perlbug> program | |
421 | included with your release. Be sure to trim your bug down to a tiny but | |
422 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
423 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
424 | ||
425 | If the bug you are reporting has security implications, which make it | |
426 | inappropriate to send to a publicly archived mailing list, then please send it | |
427 | to perl5-security-report@perl.org. This points to a closed subscription | |
428 | unarchived mailing list, which includes all the core committers, who will be | |
429 | able to help assess the impact of issues, figure out a resolution, and help | |
430 | co-ordinate the release of patches to mitigate or fix the problem across all | |
431 | platforms on which Perl is supported. Please only use this address for | |
432 | security issues in the Perl core, not for modules independently distributed on | |
433 | CPAN. | |
434 | ||
435 | =head1 SEE ALSO | |
436 | ||
437 | The F<Changes> file for an explanation of how to view exhaustive details on | |
438 | what changed. | |
439 | ||
440 | The F<INSTALL> file for how to build Perl. | |
441 | ||
442 | The F<README> file for general stuff. | |
443 | ||
444 | The F<Artistic> and F<Copying> files for copyright information. | |
445 | ||
446 | =cut |