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