Commit | Line | Data |
---|---|---|
44691e6f AB |
1 | =encoding utf8 |
2 | ||
3 | =head1 NAME | |
4 | ||
61174fb5 Z |
5 | [ this is a template for a new perldelta file. Any text flagged as |
6 | XXX needs to be processed before release. ] | |
7 | ||
8 | perldelta - what is new for perl v5.17.1 | |
27f00e3d | 9 | |
f9001595 | 10 | =head1 DESCRIPTION |
2630d42b | 11 | |
61174fb5 Z |
12 | This document describes differences between the 5.17.0 release and |
13 | the 5.17.1 release. | |
7620cb10 | 14 | |
f9001595 | 15 | If you are upgrading from an earlier release such as 5.16.0, first read |
61174fb5 Z |
16 | L<perl5170delta>, which describes differences between 5.16.0 and |
17 | 5.17.0. | |
d7c042c9 | 18 | |
61174fb5 | 19 | =head1 Notice |
2e2b2571 | 20 | |
61174fb5 | 21 | XXX Any important notices here |
417a992d | 22 | |
61174fb5 | 23 | =head1 Core Enhancements |
417a992d | 24 | |
61174fb5 Z |
25 | XXX New core language features go here. Summarise user-visible core language |
26 | enhancements. Particularly prominent performance optimisations could go | |
27 | here, but most should go in the L</Performance Enhancements> section. | |
417a992d | 28 | |
61174fb5 | 29 | [ List each enhancement as a =head2 entry ] |
075b9d7d | 30 | |
61174fb5 | 31 | =head1 Security |
075b9d7d | 32 | |
61174fb5 Z |
33 | XXX Any security-related notices go here. In particular, any security |
34 | vulnerabilities closed should be noted here rather than in the | |
35 | L</Selected Bug Fixes> section. | |
cadced9f | 36 | |
61174fb5 | 37 | [ List each security issue as a =head2 entry ] |
30608892 | 38 | |
61174fb5 | 39 | =head1 Incompatible Changes |
30608892 | 40 | |
61174fb5 | 41 | XXX For a release on a stable branch, this section aspires to be: |
05c8f9ed | 42 | |
61174fb5 Z |
43 | There are no changes intentionally incompatible with 5.XXX.XXX |
44 | If any exist, they are bugs, and we request that you submit a | |
45 | report. See L</Reporting Bugs> below. | |
05c8f9ed | 46 | |
61174fb5 | 47 | [ List each incompatible change as a =head2 entry ] |
05c8f9ed | 48 | |
61174fb5 | 49 | =head1 Deprecations |
ef7131e9 | 50 | |
61174fb5 Z |
51 | XXX Any deprecated features, syntax, modules etc. should be listed here. |
52 | In particular, deprecated modules should be listed here even if they are | |
53 | listed as an updated module in the L</Modules and Pragmata> section. | |
ef7131e9 | 54 | |
61174fb5 | 55 | [ List each deprecation as a =head2 entry ] |
ef7131e9 | 56 | |
61174fb5 | 57 | =head1 Performance Enhancements |
95ce428c | 58 | |
61174fb5 Z |
59 | XXX Changes which enhance performance without changing behaviour go here. There |
60 | may well be none in a stable release. | |
c11980ad | 61 | |
61174fb5 | 62 | [ List each enhancement as a =item entry ] |
05c8f9ed | 63 | |
f9001595 | 64 | =over 4 |
75ff5956 | 65 | |
2630d42b | 66 | =item * |
c11980ad | 67 | |
61174fb5 | 68 | XXX |
53de3ff0 | 69 | |
61174fb5 | 70 | =back |
ef7131e9 | 71 | |
61174fb5 | 72 | =head1 Modules and Pragmata |
ef7131e9 | 73 | |
61174fb5 Z |
74 | XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/> |
75 | go here. If Module::CoreList is updated, generate an initial draft of the | |
76 | following sections using F<Porting/corelist-perldelta.pl>, which prints stub | |
77 | entries to STDOUT. Results can be pasted in place of the '=head2' entries | |
78 | below. A paragraph summary for important changes should then be added by hand. | |
79 | In an ideal world, dual-life modules would have a F<Changes> file that could be | |
80 | cribbed. | |
ef7131e9 | 81 | |
61174fb5 | 82 | [ Within each section, list entries as a =item entry ] |
435b0bdb | 83 | |
61174fb5 | 84 | =head2 New Modules and Pragmata |
435b0bdb | 85 | |
61174fb5 | 86 | =over 4 |
be8dfbf7 | 87 | |
435b0bdb FC |
88 | =item * |
89 | ||
61174fb5 | 90 | XXX |
83fb037c | 91 | |
61174fb5 | 92 | =back |
83fb037c | 93 | |
61174fb5 | 94 | =head2 Updated Modules and Pragmata |
83fb037c | 95 | |
61174fb5 | 96 | =over 4 |
83fb037c FC |
97 | |
98 | =item * | |
99 | ||
61174fb5 | 100 | L<XXX> has been upgraded from version 0.69 to version 0.70. |
f558db2f | 101 | |
61174fb5 | 102 | =back |
f558db2f | 103 | |
61174fb5 | 104 | =head2 Removed Modules and Pragmata |
e3329bf0 | 105 | |
61174fb5 | 106 | =over 4 |
e3329bf0 FC |
107 | |
108 | =item * | |
109 | ||
61174fb5 | 110 | XXX |
80b8b050 | 111 | |
61174fb5 | 112 | =back |
80b8b050 | 113 | |
61174fb5 | 114 | =head1 Documentation |
80b8b050 | 115 | |
61174fb5 Z |
116 | XXX Changes to files in F<pod/> go here. Consider grouping entries by |
117 | file and be sure to link to the appropriate page, e.g. L<perlfunc>. | |
18d0dfa8 | 118 | |
61174fb5 | 119 | =head2 New Documentation |
843331c7 | 120 | |
61174fb5 | 121 | XXX Changes which create B<new> files in F<pod/> go here. |
53de3ff0 | 122 | |
61174fb5 | 123 | =head3 L<XXX> |
30608892 | 124 | |
61174fb5 | 125 | XXX Description of the purpose of the new file here |
30608892 | 126 | |
61174fb5 | 127 | =head2 Changes to Existing Documentation |
30608892 | 128 | |
61174fb5 Z |
129 | XXX Changes which significantly change existing files in F<pod/> go here. |
130 | However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics> | |
131 | section. | |
c11980ad | 132 | |
61174fb5 | 133 | =head3 L<XXX> |
ecd144ea | 134 | |
f9001595 | 135 | =over 4 |
05c8f9ed RS |
136 | |
137 | =item * | |
138 | ||
61174fb5 | 139 | XXX Description of the change here |
9dea6244 | 140 | |
204b72a4 | 141 | =back |
9dea6244 | 142 | |
61174fb5 | 143 | =head1 Diagnostics |
ef7131e9 | 144 | |
61174fb5 Z |
145 | The following additions or changes have been made to diagnostic output, |
146 | including warnings and fatal error messages. For the complete list of | |
147 | diagnostic messages, see L<perldiag>. | |
ef7131e9 | 148 | |
61174fb5 Z |
149 | XXX New or changed warnings emitted by the core's C<C> code go here. Also |
150 | include any changes in L<perldiag> that reconcile it to the C<C> code. | |
ef7131e9 | 151 | |
61174fb5 Z |
152 | [ Within each section, list entries as a =item entry that links to perldiag, |
153 | e.g. | |
ef7131e9 | 154 | |
61174fb5 | 155 | =item * |
ef7131e9 | 156 | |
61174fb5 Z |
157 | L<Invalid version object|perldiag/"Invalid version object"> |
158 | ] | |
80b8b050 | 159 | |
61174fb5 | 160 | =head2 New Diagnostics |
80b8b050 | 161 | |
61174fb5 | 162 | XXX Newly added diagnostic messages go here |
80b8b050 | 163 | |
61174fb5 | 164 | =head3 New Errors |
80b8b050 Z |
165 | |
166 | =over 4 | |
167 | ||
168 | =item * | |
169 | ||
61174fb5 | 170 | XXX L<message|perldiag/"message"> |
80b8b050 | 171 | |
52deee2e | 172 | =back |
5dd80d85 | 173 | |
f9001595 | 174 | =head3 New Warnings |
05c8f9ed | 175 | |
f9001595 | 176 | =over 4 |
05c8f9ed RS |
177 | |
178 | =item * | |
d5dc7001 | 179 | |
61174fb5 | 180 | XXX L<message|perldiag/"message"> |
30608892 | 181 | |
f9001595 | 182 | =back |
05c8f9ed | 183 | |
61174fb5 Z |
184 | =head2 Changes to Existing Diagnostics |
185 | ||
186 | XXX Changes (i.e. rewording) of diagnostic messages go here | |
05c8f9ed | 187 | |
f9001595 | 188 | =over 4 |
05c8f9ed RS |
189 | |
190 | =item * | |
191 | ||
61174fb5 | 192 | XXX Describe change here |
ef7131e9 | 193 | |
f9001595 | 194 | =back |
05c8f9ed | 195 | |
61174fb5 | 196 | =head1 Utility Changes |
05c8f9ed | 197 | |
61174fb5 Z |
198 | XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go |
199 | here. Most of these are built within the directories F<utils> and F<x2p>. | |
05c8f9ed | 200 | |
61174fb5 Z |
201 | [ List utility changes as a =head3 entry for each utility and =item |
202 | entries for each change | |
203 | Use L<XXX> with program names to get proper documentation linking. ] | |
05c8f9ed | 204 | |
61174fb5 | 205 | =head3 L<XXX> |
30608892 | 206 | |
61174fb5 | 207 | =over 4 |
30608892 | 208 | |
61174fb5 | 209 | =item * |
30608892 | 210 | |
61174fb5 | 211 | XXX |
30608892 | 212 | |
61174fb5 | 213 | =back |
30608892 | 214 | |
61174fb5 | 215 | =head1 Configuration and Compilation |
30608892 | 216 | |
61174fb5 Z |
217 | XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools |
218 | go here. Any other changes to the Perl build process should be listed here. | |
219 | However, any platform-specific changes should be listed in the | |
220 | L</Platform Support> section, instead. | |
05c8f9ed | 221 | |
61174fb5 | 222 | [ List changes as a =item entry ]. |
05c8f9ed | 223 | |
f9001595 | 224 | =over 4 |
05c8f9ed RS |
225 | |
226 | =item * | |
227 | ||
61174fb5 | 228 | XXX |
53de3ff0 | 229 | |
61174fb5 | 230 | =back |
a3367fba | 231 | |
61174fb5 | 232 | =head1 Testing |
a3367fba | 233 | |
61174fb5 Z |
234 | XXX Any significant changes to the testing of a freshly built perl should be |
235 | listed here. Changes which create B<new> files in F<t/> go here as do any | |
236 | large changes to the testing harness (e.g. when parallel testing was added). | |
237 | Changes to existing files in F<t/> aren't worth summarising, although the bugs | |
238 | that they represent may be covered elsewhere. | |
a3367fba | 239 | |
61174fb5 | 240 | [ List each test improvement as a =item entry ] |
a3367fba | 241 | |
61174fb5 | 242 | =over 4 |
05c8f9ed | 243 | |
30608892 Z |
244 | =item * |
245 | ||
61174fb5 | 246 | XXX |
30608892 | 247 | |
f9001595 | 248 | =back |
05c8f9ed | 249 | |
61174fb5 | 250 | =head1 Platform Support |
05c8f9ed | 251 | |
61174fb5 | 252 | XXX Any changes to platform support should be listed in the sections below. |
05c8f9ed | 253 | |
61174fb5 Z |
254 | [ Within the sections, list each platform as a =item entry with specific |
255 | changes as paragraphs below it. ] | |
05c8f9ed | 256 | |
61174fb5 | 257 | =head2 New Platforms |
e2e06450 | 258 | |
61174fb5 Z |
259 | XXX List any platforms that this version of perl compiles on, that previous |
260 | versions did not. These will either be enabled by new files in the F<hints/> | |
261 | directories, or new subdirectories and F<README> files at the top level of the | |
262 | source tree. | |
b9b99128 | 263 | |
61174fb5 | 264 | =over 4 |
b9b99128 | 265 | |
61174fb5 | 266 | =item XXX-some-platform |
47fb883d | 267 | |
61174fb5 | 268 | XXX |
47fb883d | 269 | |
61174fb5 | 270 | =back |
5f0f4bc0 | 271 | |
61174fb5 | 272 | =head2 Discontinued Platforms |
5f0f4bc0 | 273 | |
61174fb5 | 274 | XXX List any platforms that this version of perl no longer compiles on. |
ba0d99ee | 275 | |
61174fb5 | 276 | =over 4 |
ba0d99ee | 277 | |
61174fb5 | 278 | =item XXX-some-platform |
72035cb1 | 279 | |
61174fb5 | 280 | XXX |
72035cb1 | 281 | |
61174fb5 | 282 | =back |
ceb0881c | 283 | |
61174fb5 | 284 | =head2 Platform-Specific Notes |
ceb0881c | 285 | |
61174fb5 Z |
286 | XXX List any changes for specific platforms. This could include configuration |
287 | and compilation changes or changes in portability/compatibility. However, | |
288 | changes within modules for platforms should generally be listed in the | |
289 | L</Modules and Pragmata> section. | |
89cbc6b8 | 290 | |
61174fb5 | 291 | =over 4 |
89cbc6b8 | 292 | |
61174fb5 | 293 | =item XXX-some-platform |
c6b15a5a | 294 | |
61174fb5 | 295 | XXX |
c6b15a5a | 296 | |
61174fb5 | 297 | =back |
8e125188 | 298 | |
61174fb5 | 299 | =head1 Internal Changes |
8e125188 | 300 | |
61174fb5 Z |
301 | XXX Changes which affect the interface available to C<XS> code go here. |
302 | Other significant internal changes for future core maintainers should | |
303 | be noted as well. | |
8e125188 | 304 | |
61174fb5 | 305 | [ List each change as a =item entry ] |
c4643160 | 306 | |
61174fb5 | 307 | =over 4 |
c4643160 | 308 | |
422287bf FC |
309 | =item * |
310 | ||
61174fb5 | 311 | XXX |
53de3ff0 | 312 | |
61174fb5 | 313 | =back |
422287bf | 314 | |
61174fb5 | 315 | =head1 Selected Bug Fixes |
2de6ba8d | 316 | |
61174fb5 Z |
317 | XXX Important bug fixes in the core language are summarised here. |
318 | Bug fixes in files in F<ext/> and F<lib/> are best summarised in | |
319 | L</Modules and Pragmata>. | |
2de6ba8d | 320 | |
61174fb5 | 321 | [ List each fix as a =item entry ] |
52c4b146 | 322 | |
61174fb5 | 323 | =over 4 |
52c4b146 | 324 | |
9aa9a888 KW |
325 | =item * |
326 | ||
61174fb5 | 327 | XXX |
9aa9a888 | 328 | |
61174fb5 | 329 | =back |
53de3ff0 | 330 | |
61174fb5 | 331 | =head1 Known Problems |
53de3ff0 | 332 | |
61174fb5 Z |
333 | XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any |
334 | tests that had to be C<TODO>ed for the release would be noted here, unless | |
335 | they were specific to a particular platform (see below). | |
53de3ff0 | 336 | |
61174fb5 Z |
337 | This is a list of some significant unfixed bugs, which are regressions |
338 | from either 5.XXX.XXX or 5.XXX.XXX. | |
53de3ff0 | 339 | |
61174fb5 | 340 | [ List each fix as a =item entry ] |
80b8b050 | 341 | |
61174fb5 | 342 | =over 4 |
80b8b050 | 343 | |
eb3d0a58 LT |
344 | =item * |
345 | ||
61174fb5 | 346 | XXX |
eb3d0a58 | 347 | |
2630d42b | 348 | =back |
e2e06450 | 349 | |
61174fb5 | 350 | =head1 Obituary |
c0154fe2 | 351 | |
61174fb5 Z |
352 | XXX If any significant core contributor has died, we've added a short obituary |
353 | here. | |
d5dc7001 | 354 | |
61174fb5 | 355 | =head1 Acknowledgements |
d5dc7001 | 356 | |
61174fb5 | 357 | XXX Generate this with: |
f9001595 | 358 | |
61174fb5 | 359 | perl Porting/acknowledgements.pl v5.17.0..HEAD |
29cf780c | 360 | |
44691e6f AB |
361 | =head1 Reporting Bugs |
362 | ||
363 | If you find what you think is a bug, you might check the articles | |
52deee2e | 364 | recently posted to the comp.lang.perl.misc newsgroup and the perl |
f9001595 RS |
365 | bug database at http://rt.perl.org/perlbug/ . There may also be |
366 | information at http://www.perl.org/ , the Perl Home Page. | |
44691e6f AB |
367 | |
368 | If you believe you have an unreported bug, please run the L<perlbug> | |
52deee2e DR |
369 | program included with your release. Be sure to trim your bug down |
370 | to a tiny but sufficient test case. Your bug report, along with the | |
371 | output of C<perl -V>, will be sent off to perlbug@perl.org to be | |
372 | analysed by the Perl porting team. | |
44691e6f AB |
373 | |
374 | If the bug you are reporting has security implications, which make it | |
f9001595 RS |
375 | inappropriate to send to a publicly archived mailing list, then please send |
376 | it to perl5-security-report@perl.org. This points to a closed subscription | |
377 | unarchived mailing list, which includes | |
378 | all the core committers, who will be able | |
379 | to help assess the impact of issues, figure out a resolution, and help | |
380 | co-ordinate the release of patches to mitigate or fix the problem across all | |
381 | platforms on which Perl is supported. Please only use this address for | |
382 | security issues in the Perl core, not for modules independently | |
383 | distributed on CPAN. | |
44691e6f AB |
384 | |
385 | =head1 SEE ALSO | |
386 | ||
52deee2e DR |
387 | The F<Changes> file for an explanation of how to view exhaustive details |
388 | on what changed. | |
44691e6f AB |
389 | |
390 | The F<INSTALL> file for how to build Perl. | |
391 | ||
392 | The F<README> file for general stuff. | |
393 | ||
394 | The F<Artistic> and F<Copying> files for copyright information. | |
395 | ||
396 | =cut |