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