Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
19718730 AC |
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.17.9 | |
e128ab2c | 9 | |
4eabcf70 | 10 | =head1 DESCRIPTION |
6db9054f | 11 | |
19718730 | 12 | This document describes differences between the 5.17.8 release and the 5.17.9 |
e08634c5 | 13 | release. |
6db9054f | 14 | |
19718730 AC |
15 | If you are upgrading from an earlier release such as 5.17.7, first read |
16 | L<perl5178delta>, which describes differences between 5.17.7 and 5.17.8. | |
17 | ||
18 | =head1 Notice | |
19 | ||
20 | XXX Any important notices here | |
bde9e88d | 21 | |
6253ee75 | 22 | =head1 Core Enhancements |
dd271d7a | 23 | |
19718730 AC |
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 ] | |
9d1a5160 | 37 | |
19718730 AC |
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 ] | |
9d1a5160 | 47 | |
0e55f0d7 | 48 | =head1 Deprecations |
3ef6ec90 | 49 | |
19718730 AC |
50 | XXX Any deprecated features, syntax, modules etc. should be listed here. In |
51 | particular, deprecated modules should be listed here even if they are listed as | |
52 | an updated module in the L</Modules and Pragmata> section. | |
4d68ffa0 | 53 | |
19718730 AC |
54 | [ List each deprecation as a =head2 entry ] |
55 | ||
ff56e4f1 KW |
56 | =head2 Five additional characters should be escaped in patterns with C</x> |
57 | ||
58 | When a regular expression pattern is compiled with C</x>, Perl treats 6 | |
59 | characters as white space to ignore, such as SPACE and TAB. However, | |
60 | Unicode recommends 11 characters be treated thusly. In preparation to | |
61 | conforming with this in a future Perl version, in the meantime, use of | |
62 | any of the missing characters will raise a deprecation warning, unless | |
63 | turned off. The five characters are: | |
64 | U+0085 NEXT LINE, | |
65 | U+200E LEFT-TO-RIGHT MARK, | |
66 | U+200F RIGHT-TO-LEFT MARK, | |
67 | U+2028 LINE SEPARATOR, | |
68 | and | |
69 | U+2029 PARAGRAPH SEPARATOR. | |
70 | ||
19718730 AC |
71 | =head1 Performance Enhancements |
72 | ||
73 | XXX Changes which enhance performance without changing behaviour go here. | |
74 | There may well be none in a stable release. | |
751611d4 | 75 | |
19718730 | 76 | [ List each enhancement as a =item entry ] |
751611d4 | 77 | |
6253ee75 | 78 | =over 4 |
751611d4 FC |
79 | |
80 | =item * | |
81 | ||
19718730 AC |
82 | XXX |
83 | ||
84 | =back | |
85 | ||
86 | =head1 Modules and Pragmata | |
87 | ||
88 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> | |
89 | go here. If Module::CoreList is updated, generate an initial draft of the | |
90 | following sections using F<Porting/corelist-perldelta.pl>, which prints stub | |
91 | entries to STDOUT. Results can be pasted in place of the '=head2' entries | |
92 | below. A paragraph summary for important changes should then be added by hand. | |
93 | In an ideal world, dual-life modules would have a F<Changes> file that could be | |
94 | cribbed. | |
95 | ||
96 | [ Within each section, list entries as a =item entry ] | |
97 | ||
98 | =head2 New Modules and Pragmata | |
751611d4 | 99 | |
6253ee75 | 100 | =over 4 |
751611d4 FC |
101 | |
102 | =item * | |
103 | ||
19718730 | 104 | XXX |
751611d4 | 105 | |
19718730 | 106 | =back |
86148eee | 107 | |
19718730 AC |
108 | =head2 Updated Modules and Pragmata |
109 | ||
110 | =over 4 | |
7a7a10c7 | 111 | |
e14ac59b | 112 | =item * |
7a7a10c7 | 113 | |
e58c5aaf TC |
114 | L<PerlIO::scalar> has been upgraded from version 0.15 to 0.16. |
115 | ||
116 | The buffer scalar supplied may now only contain code pounts 0xFF or | |
117 | lower. [perl #109828] | |
7a7a10c7 | 118 | |
19718730 AC |
119 | =back |
120 | ||
121 | =head2 Removed Modules and Pragmata | |
c387386a | 122 | |
19718730 | 123 | =over 4 |
32209f41 | 124 | |
e14ac59b | 125 | =item * |
5faa50e9 | 126 | |
19718730 | 127 | XXX |
b7c7d786 | 128 | |
6253ee75 | 129 | =back |
b7c7d786 | 130 | |
19718730 | 131 | =head1 Documentation |
11e375e0 | 132 | |
19718730 AC |
133 | XXX Changes to files in F<pod/> go here. Consider grouping entries by |
134 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
e498bd59 | 135 | |
19718730 AC |
136 | =head2 New Documentation |
137 | ||
138 | XXX Changes which create B<new> files in F<pod/> go here. | |
e498bd59 | 139 | |
19718730 AC |
140 | =head3 L<XXX> |
141 | ||
142 | XXX Description of the purpose of the new file here | |
143 | ||
144 | =head2 Changes to Existing Documentation | |
145 | ||
146 | XXX Changes which significantly change existing files in F<pod/> go here. | |
147 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
148 | section. | |
149 | ||
150 | =head3 L<XXX> | |
151 | ||
152 | =over 4 | |
dd4b1c75 AC |
153 | |
154 | =item * | |
155 | ||
19718730 | 156 | XXX Description of the change here |
cb077ed2 | 157 | |
5d8c8c8a | 158 | =back |
5f877a7f | 159 | |
e14ac59b RS |
160 | =head1 Diagnostics |
161 | ||
162 | The following additions or changes have been made to diagnostic output, | |
163 | including warnings and fatal error messages. For the complete list of | |
164 | diagnostic messages, see L<perldiag>. | |
1ea91bbe | 165 | |
19718730 AC |
166 | XXX New or changed warnings emitted by the core's C<C> code go here. Also |
167 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
168 | ||
6253ee75 DR |
169 | =head2 New Diagnostics |
170 | ||
19718730 AC |
171 | XXX Newly added diagnostic messages go under here, separated into New Errors |
172 | and New Warnings | |
173 | ||
174 | =head3 New Errors | |
11e375e0 | 175 | |
e14ac59b | 176 | =over 4 |
11e375e0 FC |
177 | |
178 | =item * | |
179 | ||
19718730 AC |
180 | XXX L<message|perldiag/"message"> |
181 | ||
182 | =back | |
183 | ||
184 | =head3 New Warnings | |
185 | ||
186 | =over 4 | |
5e0a247b KW |
187 | |
188 | =item * | |
189 | ||
19718730 AC |
190 | XXX L<message|perldiag/"message"> |
191 | ||
192 | =back | |
193 | ||
194 | =head2 Changes to Existing Diagnostics | |
195 | ||
196 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
197 | ||
198 | =over 4 | |
e14ac59b | 199 | |
6253ee75 | 200 | =item * |
8b877d20 | 201 | |
19718730 AC |
202 | XXX Describe change here |
203 | ||
204 | =back | |
205 | ||
206 | =head1 Utility Changes | |
207 | ||
208 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here. | |
209 | Most of these are built within the directories F<utils> and F<x2p>. | |
210 | ||
211 | [ List utility changes as a =head3 entry for each utility and =item | |
212 | entries for each change | |
213 | Use L<XXX> with program names to get proper documentation linking. ] | |
214 | ||
215 | =head3 L<XXX> | |
216 | ||
217 | =over 4 | |
e078d89d FC |
218 | |
219 | =item * | |
220 | ||
19718730 | 221 | XXX |
e078d89d | 222 | |
6253ee75 | 223 | =back |
e078d89d | 224 | |
19718730 AC |
225 | =head1 Configuration and Compilation |
226 | ||
227 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools | |
228 | go here. Any other changes to the Perl build process should be listed here. | |
229 | However, any platform-specific changes should be listed in the | |
230 | L</Platform Support> section, instead. | |
231 | ||
232 | [ List changes as a =item entry ]. | |
e078d89d | 233 | |
6253ee75 | 234 | =over 4 |
e078d89d | 235 | |
b7c7d786 FC |
236 | =item * |
237 | ||
19718730 AC |
238 | XXX |
239 | ||
240 | =back | |
241 | ||
242 | =head1 Testing | |
243 | ||
244 | XXX Any significant changes to the testing of a freshly built perl should be | |
245 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
246 | large changes to the testing harness (e.g. when parallel testing was added). | |
247 | Changes to existing files in F<t/> aren't worth summarizing, although the bugs | |
248 | that they represent may be covered elsewhere. | |
249 | ||
250 | [ List each test improvement as a =item entry ] | |
251 | ||
252 | =over 4 | |
e14ac59b | 253 | |
fdea6f98 FC |
254 | =item * |
255 | ||
19718730 | 256 | XXX |
fdea6f98 | 257 | |
6253ee75 | 258 | =back |
7cf3104f | 259 | |
6253ee75 | 260 | =head1 Platform Support |
7cf3104f | 261 | |
19718730 AC |
262 | XXX Any changes to platform support should be listed in the sections below. |
263 | ||
264 | [ Within the sections, list each platform as a =item entry with specific | |
265 | changes as paragraphs below it. ] | |
266 | ||
267 | =head2 New Platforms | |
268 | ||
269 | XXX List any platforms that this version of perl compiles on, that previous | |
270 | versions did not. These will either be enabled by new files in the F<hints/> | |
271 | directories, or new subdirectories and F<README> files at the top level of the | |
272 | source tree. | |
a0e45bac | 273 | |
6253ee75 | 274 | =over 4 |
139353f8 | 275 | |
19718730 | 276 | =item XXX-some-platform |
139353f8 | 277 | |
19718730 | 278 | XXX |
ba535ffe | 279 | |
6253ee75 | 280 | =back |
ba535ffe | 281 | |
19718730 AC |
282 | =head2 Discontinued Platforms |
283 | ||
284 | XXX List any platforms that this version of perl no longer compiles on. | |
52c09c59 | 285 | |
6253ee75 | 286 | =over 4 |
12b847a2 | 287 | |
19718730 AC |
288 | =item XXX-some-platform |
289 | ||
290 | XXX | |
12b847a2 | 291 | |
19718730 AC |
292 | =back |
293 | ||
294 | =head2 Platform-Specific Notes | |
295 | ||
296 | XXX List any changes for specific platforms. This could include configuration | |
297 | and compilation changes or changes in portability/compatibility. However, | |
298 | changes within modules for platforms should generally be listed in the | |
299 | L</Modules and Pragmata> section. | |
300 | ||
301 | =over 4 | |
6e50262c | 302 | |
19718730 | 303 | =item XXX-some-platform |
6e50262c | 304 | |
19718730 | 305 | XXX |
785fb813 | 306 | |
0e55f0d7 | 307 | =back |
785fb813 | 308 | |
0e55f0d7 | 309 | =head1 Internal Changes |
f5778209 | 310 | |
19718730 AC |
311 | XXX Changes which affect the interface available to C<XS> code go here. Other |
312 | significant internal changes for future core maintainers should be noted as | |
313 | well. | |
314 | ||
315 | [ List each change as a =item entry ] | |
316 | ||
6253ee75 | 317 | =over 4 |
f5778209 | 318 | |
216cf7fc DR |
319 | =item * |
320 | ||
19718730 | 321 | XXX |
216cf7fc | 322 | |
6253ee75 | 323 | =back |
216cf7fc | 324 | |
6253ee75 | 325 | =head1 Selected Bug Fixes |
216cf7fc | 326 | |
19718730 AC |
327 | XXX Important bug fixes in the core language are summarized here. Bug fixes in |
328 | files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>. | |
216cf7fc | 329 | |
19718730 | 330 | [ List each fix as a =item entry ] |
216cf7fc | 331 | |
19718730 | 332 | =over 4 |
216cf7fc | 333 | |
d76c0f4b RS |
334 | =item * |
335 | ||
58cbf594 TC |
336 | -DPERL_GLOBAL_STRUCT builds now free the global struct B<after> |
337 | they've finished using it. | |
d76c0f4b | 338 | |
6253ee75 | 339 | =back |
6c042f06 | 340 | |
6253ee75 | 341 | =head1 Known Problems |
6c042f06 | 342 | |
19718730 AC |
343 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any |
344 | tests that had to be C<TODO>ed for the release would be noted here. Unfixed | |
345 | platform specific bugs also go here. | |
3cf48cac | 346 | |
19718730 | 347 | [ List each fix as a =item entry ] |
3cf48cac | 348 | |
19718730 | 349 | =over 4 |
05bee12a | 350 | |
100e3bc8 AC |
351 | =item * |
352 | ||
19718730 | 353 | XXX |
100e3bc8 | 354 | |
6253ee75 | 355 | =back |
f5b73711 | 356 | |
19718730 | 357 | =head1 Obituary |
f5b73711 | 358 | |
19718730 AC |
359 | XXX If any significant core contributor has died, we've added a short obituary |
360 | here. | |
0e55f0d7 | 361 | |
19718730 | 362 | =head1 Acknowledgements |
f5b73711 | 363 | |
19718730 | 364 | XXX Generate this with: |
f5b73711 | 365 | |
19718730 | 366 | perl Porting/acknowledgements.pl v5.17.8..HEAD |
f5b73711 | 367 | |
44691e6f AB |
368 | =head1 Reporting Bugs |
369 | ||
e08634c5 SH |
370 | If you find what you think is a bug, you might check the articles recently |
371 | posted to the comp.lang.perl.misc newsgroup and the perl bug database at | |
372 | http://rt.perl.org/perlbug/ . There may also be information at | |
373 | http://www.perl.org/ , the Perl Home Page. | |
44691e6f | 374 | |
e08634c5 SH |
375 | If you believe you have an unreported bug, please run the L<perlbug> program |
376 | included with your release. Be sure to trim your bug down to a tiny but | |
377 | sufficient test case. Your bug report, along with the output of C<perl -V>, | |
378 | will be sent off to perlbug@perl.org to be analysed by the Perl porting team. | |
44691e6f AB |
379 | |
380 | If the bug you are reporting has security implications, which make it | |
e08634c5 SH |
381 | inappropriate to send to a publicly archived mailing list, then please send it |
382 | to perl5-security-report@perl.org. This points to a closed subscription | |
383 | unarchived mailing list, which includes all the core committers, who will be | |
384 | able to help assess the impact of issues, figure out a resolution, and help | |
f9001595 | 385 | co-ordinate the release of patches to mitigate or fix the problem across all |
e08634c5 SH |
386 | platforms on which Perl is supported. Please only use this address for |
387 | security issues in the Perl core, not for modules independently distributed on | |
388 | CPAN. | |
44691e6f AB |
389 | |
390 | =head1 SEE ALSO | |
391 | ||
e08634c5 SH |
392 | The F<Changes> file for an explanation of how to view exhaustive details on |
393 | what changed. | |
44691e6f AB |
394 | |
395 | The F<INSTALL> file for how to build Perl. | |
396 | ||
397 | The F<README> file for general stuff. | |
398 | ||
399 | The F<Artistic> and F<Copying> files for copyright information. | |
400 | ||
401 | =cut |