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