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