| 1 | =encoding utf8 |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 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.tXXX.cXXX |
| 9 | |
| 10 | =head1 DESCRIPTION |
| 11 | |
| 12 | This document describes differences between the 5.sXXX.bXXX release and |
| 13 | the 5.tXXX.cXXX release. |
| 14 | |
| 15 | If you are upgrading from an earlier release such as 5.rXXX.aXXX, first read |
| 16 | L<perl5XXXdelta>, which describes differences between 5.rXXX.aXXX and |
| 17 | 5.sXXX.bXXX. |
| 18 | |
| 19 | =head1 Notice |
| 20 | |
| 21 | XXX Any important notices here |
| 22 | |
| 23 | =head1 Core Enhancements |
| 24 | |
| 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. |
| 28 | |
| 29 | [ List each enhancement as a =head2 entry ] |
| 30 | |
| 31 | =head1 Security |
| 32 | |
| 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. |
| 36 | |
| 37 | [ List each security issue as a =head2 entry ] |
| 38 | |
| 39 | =head1 Incompatible Changes |
| 40 | |
| 41 | XXX For a release on a stable branch, this section aspires to be: |
| 42 | |
| 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. |
| 46 | |
| 47 | [ List each incompatible change as a =head2 entry ] |
| 48 | |
| 49 | =head1 Deprecations |
| 50 | |
| 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. |
| 54 | |
| 55 | [ List each deprecation as a =head2 entry ] |
| 56 | |
| 57 | =head1 Performance Enhancements |
| 58 | |
| 59 | XXX Changes which enhance performance without changing behaviour go here. There |
| 60 | may well be none in a stable release. |
| 61 | |
| 62 | [ List each enhancement as a =item entry ] |
| 63 | |
| 64 | =over 4 |
| 65 | |
| 66 | =item * |
| 67 | |
| 68 | XXX |
| 69 | |
| 70 | =back |
| 71 | |
| 72 | =head1 Modules and Pragmata |
| 73 | |
| 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. |
| 81 | |
| 82 | [ Within each section, list entries as a =item entry ] |
| 83 | |
| 84 | =head2 New Modules and Pragmata |
| 85 | |
| 86 | =over 4 |
| 87 | |
| 88 | =item * |
| 89 | |
| 90 | XXX |
| 91 | |
| 92 | =back |
| 93 | |
| 94 | =head2 Updated Modules and Pragmata |
| 95 | |
| 96 | =over 4 |
| 97 | |
| 98 | =item * |
| 99 | |
| 100 | L<XXX> has been upgraded from version 0.69 to version 0.70. |
| 101 | |
| 102 | =back |
| 103 | |
| 104 | =head2 Removed Modules and Pragmata |
| 105 | |
| 106 | =over 4 |
| 107 | |
| 108 | =item * |
| 109 | |
| 110 | XXX |
| 111 | |
| 112 | =back |
| 113 | |
| 114 | =head1 Documentation |
| 115 | |
| 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>. |
| 118 | |
| 119 | =head2 New Documentation |
| 120 | |
| 121 | XXX Changes which create B<new> files in F<pod/> go here. |
| 122 | |
| 123 | =head3 L<XXX> |
| 124 | |
| 125 | XXX Description of the purpose of the new file here |
| 126 | |
| 127 | =head2 Changes to Existing Documentation |
| 128 | |
| 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. |
| 132 | |
| 133 | =head3 L<XXX> |
| 134 | |
| 135 | =over 4 |
| 136 | |
| 137 | =item * |
| 138 | |
| 139 | XXX Description of the change here |
| 140 | |
| 141 | =back |
| 142 | |
| 143 | =head1 Diagnostics |
| 144 | |
| 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>. |
| 148 | |
| 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. |
| 151 | |
| 152 | [ Within each section, list entries as a =item entry that links to perldiag, |
| 153 | e.g. |
| 154 | |
| 155 | =item * |
| 156 | |
| 157 | L<Invalid version object|perldiag/"Invalid version object"> |
| 158 | ] |
| 159 | |
| 160 | =head2 New Diagnostics |
| 161 | |
| 162 | XXX Newly added diagnostic messages go here |
| 163 | |
| 164 | =head3 New Errors |
| 165 | |
| 166 | =over 4 |
| 167 | |
| 168 | =item * |
| 169 | |
| 170 | XXX L<message|perldiag/"message"> |
| 171 | |
| 172 | =back |
| 173 | |
| 174 | =head3 New Warnings |
| 175 | |
| 176 | =over 4 |
| 177 | |
| 178 | =item * |
| 179 | |
| 180 | XXX L<message|perldiag/"message"> |
| 181 | |
| 182 | =back |
| 183 | |
| 184 | =head2 Changes to Existing Diagnostics |
| 185 | |
| 186 | XXX Changes (i.e. rewording) of diagnostic messages go here |
| 187 | |
| 188 | =over 4 |
| 189 | |
| 190 | =item * |
| 191 | |
| 192 | XXX Describe change here |
| 193 | |
| 194 | =back |
| 195 | |
| 196 | =head1 Utility Changes |
| 197 | |
| 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>. |
| 200 | |
| 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. ] |
| 204 | |
| 205 | =head3 L<XXX> |
| 206 | |
| 207 | =over 4 |
| 208 | |
| 209 | =item * |
| 210 | |
| 211 | XXX |
| 212 | |
| 213 | =back |
| 214 | |
| 215 | =head1 Configuration and Compilation |
| 216 | |
| 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. |
| 221 | |
| 222 | [ List changes as a =item entry ]. |
| 223 | |
| 224 | =over 4 |
| 225 | |
| 226 | =item * |
| 227 | |
| 228 | XXX |
| 229 | |
| 230 | =back |
| 231 | |
| 232 | =head1 Testing |
| 233 | |
| 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. |
| 239 | |
| 240 | [ List each test improvement as a =item entry ] |
| 241 | |
| 242 | =over 4 |
| 243 | |
| 244 | =item * |
| 245 | |
| 246 | XXX |
| 247 | |
| 248 | =back |
| 249 | |
| 250 | =head1 Platform Support |
| 251 | |
| 252 | XXX Any changes to platform support should be listed in the sections below. |
| 253 | |
| 254 | [ Within the sections, list each platform as a =item entry with specific |
| 255 | changes as paragraphs below it. ] |
| 256 | |
| 257 | =head2 New Platforms |
| 258 | |
| 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. |
| 263 | |
| 264 | =over 4 |
| 265 | |
| 266 | =item XXX-some-platform |
| 267 | |
| 268 | XXX |
| 269 | |
| 270 | =back |
| 271 | |
| 272 | =head2 Discontinued Platforms |
| 273 | |
| 274 | XXX List any platforms that this version of perl no longer compiles on. |
| 275 | |
| 276 | =over 4 |
| 277 | |
| 278 | =item XXX-some-platform |
| 279 | |
| 280 | XXX |
| 281 | |
| 282 | =back |
| 283 | |
| 284 | =head2 Platform-Specific Notes |
| 285 | |
| 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. |
| 290 | |
| 291 | =over 4 |
| 292 | |
| 293 | =item XXX-some-platform |
| 294 | |
| 295 | XXX |
| 296 | |
| 297 | =back |
| 298 | |
| 299 | =head1 Internal Changes |
| 300 | |
| 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. |
| 304 | |
| 305 | [ List each change as a =item entry ] |
| 306 | |
| 307 | =over 4 |
| 308 | |
| 309 | =item * |
| 310 | |
| 311 | XXX |
| 312 | |
| 313 | =back |
| 314 | |
| 315 | =head1 Selected Bug Fixes |
| 316 | |
| 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>. |
| 320 | |
| 321 | [ List each fix as a =item entry ] |
| 322 | |
| 323 | =over 4 |
| 324 | |
| 325 | =item * |
| 326 | |
| 327 | XXX |
| 328 | |
| 329 | =back |
| 330 | |
| 331 | =head1 Known Problems |
| 332 | |
| 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. Unfixed |
| 335 | platform specific bugs also go here. |
| 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 Obituary |
| 348 | |
| 349 | XXX If any significant core contributor has died, we've added a short obituary |
| 350 | here. |
| 351 | |
| 352 | =head1 Acknowledgements |
| 353 | |
| 354 | XXX Generate this with: |
| 355 | |
| 356 | perl Porting/acknowledgements.pl v5.17.3..HEAD |
| 357 | |
| 358 | =head1 Reporting Bugs |
| 359 | |
| 360 | If you find what you think is a bug, you might check the articles |
| 361 | recently posted to the comp.lang.perl.misc newsgroup and the perl |
| 362 | bug database at http://rt.perl.org/perlbug/ . There may also be |
| 363 | information at http://www.perl.org/ , the Perl Home Page. |
| 364 | |
| 365 | If you believe you have an unreported bug, please run the L<perlbug> |
| 366 | program included with your release. Be sure to trim your bug down |
| 367 | to a tiny but sufficient test case. Your bug report, along with the |
| 368 | output of C<perl -V>, will be sent off to perlbug@perl.org to be |
| 369 | analysed by the Perl porting team. |
| 370 | |
| 371 | If the bug you are reporting has security implications, which make it |
| 372 | inappropriate to send to a publicly archived mailing list, then please send |
| 373 | it to perl5-security-report@perl.org. This points to a closed subscription |
| 374 | unarchived mailing list, which includes |
| 375 | all the core committers, who will be able |
| 376 | to help assess the impact of issues, figure out a resolution, and help |
| 377 | co-ordinate the release of patches to mitigate or fix the problem across all |
| 378 | platforms on which Perl is supported. Please only use this address for |
| 379 | security issues in the Perl core, not for modules independently |
| 380 | distributed on CPAN. |
| 381 | |
| 382 | =head1 SEE ALSO |
| 383 | |
| 384 | The F<Changes> file for an explanation of how to view exhaustive details |
| 385 | on what changed. |
| 386 | |
| 387 | The F<INSTALL> file for how to build Perl. |
| 388 | |
| 389 | The F<README> file for general stuff. |
| 390 | |
| 391 | The F<Artistic> and F<Copying> files for copyright information. |
| 392 | |
| 393 | =cut |