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.31.4
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.31.3 release and the 5.31.4
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.31.2, first read
  16 L<perl5313delta>, which describes differences between 5.31.2 and 5.31.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 Now can dump compiled patterns before optimization
  31
  32 This is primarily useful for tracking down bugs in the regular
  33 expression compiler.  This dump happens on C<-DDEBUGGING> perls, if you
  34 specify C<-Drv> on the command line; or on any perl if the pattern is
  35 compiled within the scope of S<C<use re qw(Debug DUMP_PRE_OPTIMIZE)>> or
  36 S<C<use re qw(Debug COMPILE EXTRA)>>.  (All but the 2nd case display
  37 other information as well.)
  38
  39 =head1 Security
  40
  41 XXX Any security-related notices go here.  In particular, any security
  42 vulnerabilities closed should be noted here rather than in the
  43 L</Selected Bug Fixes> section.
  44
  45 [ List each security issue as a =head2 entry ]
  46
  47 =head1 Incompatible Changes
  48
  49 XXX For a release on a stable branch, this section aspires to be:
  50
  51     There are no changes intentionally incompatible with 5.XXX.XXX
  52     If any exist, they are bugs, and we request that you submit a
  53     report.  See L</Reporting Bugs> below.
  54
  55 [ List each incompatible change as a =head2 entry ]
  56
  57 =head1 Deprecations
  58
  59 XXX Any deprecated features, syntax, modules etc. should be listed here.
  60
  61 =head2 Module removals
  62
  63 XXX Remove this section if not applicable.
  64
  65 The following modules will be removed from the core distribution in a
  66 future release, and will at that time need to be installed from CPAN.
  67 Distributions on CPAN which require these modules will need to list them as
  68 prerequisites.
  69
  70 The core versions of these modules will now issue C<"deprecated">-category
  71 warnings to alert you to this fact.  To silence these deprecation warnings,
  72 install the modules in question from CPAN.
  73
  74 Note that these are (with rare exceptions) fine modules that you are encouraged
  75 to continue to use.  Their disinclusion from core primarily hinges on their
  76 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
  77 not usually on concerns over their design.
  78
  79 =over
  80
  81 =item XXX
  82
  83 XXX Note that deprecated modules should be listed here even if they are listed
  84 as an updated module in the L</Modules and Pragmata> section.
  85
  86 =back
  87
  88 [ List each other deprecation as a =head2 entry ]
  89
  90 =head1 Performance Enhancements
  91
  92 XXX Changes which enhance performance without changing behaviour go here.
  93 There may well be none in a stable release.
  94
  95 [ List each enhancement as an =item entry ]
  96
  97 =over 4
  98
  99 =item *
 100
 101 XXX
 102
 103 =back
 104
 105 =head1 Modules and Pragmata
 106
 107 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
 108 go here.  If Module::CoreList is updated, generate an initial draft of the
 109 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
 110 for important changes should then be added by hand.  In an ideal world,
 111 dual-life modules would have a F<Changes> file that could be cribbed.
 112
 113 The list of new and updated modules is modified automatically as part of
 114 preparing a Perl release, so the only reason to manually add entries here is if
 115 you're summarising the important changes in the module update. (Also, if the
 116 manually-added details don't match the automatically-generated ones, the
 117 release manager will have to investigate the situation carefully.)
 118
 119 [ Within each section, list entries as an =item entry ]
 120
 121 =head2 New Modules and Pragmata
 122
 123 =over 4
 124
 125 =item *
 126
 127 XXX Remove this section if not applicable.
 128
 129 =back
 130
 131 =head2 Updated Modules and Pragmata
 132
 133 =over 4
 134
 135 =item *
 136
 137 L<XXX> has been upgraded from version A.xx to B.yy.
 138
 139 If there was something important to note about this change, include that here.
 140
 141 =back
 142
 143 =head2 Removed Modules and Pragmata
 144
 145 =over 4
 146
 147 =item *
 148
 149 XXX
 150
 151 =back
 152
 153 =head1 Documentation
 154
 155 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 156 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 157
 158 =head2 New Documentation
 159
 160 XXX Changes which create B<new> files in F<pod/> go here.
 161
 162 =head3 L<XXX>
 163
 164 XXX Description of the purpose of the new file here
 165
 166 =head2 Changes to Existing Documentation
 167
 168 We have attempted to update the documentation to reflect the changes
 169 listed in this document.  If you find any we have missed, send email
 170 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
 171
 172 XXX Changes which significantly change existing files in F<pod/> go here.
 173 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 174 section.
 175
 176 Additionally, the following selected changes have been made:
 177
 178 =head3 L<XXX>
 179
 180 =over 4
 181
 182 =item *
 183
 184 XXX Description of the change here
 185
 186 =back
 187
 188 =head1 Diagnostics
 189
 190 The following additions or changes have been made to diagnostic output,
 191 including warnings and fatal error messages.  For the complete list of
 192 diagnostic messages, see L<perldiag>.
 193
 194 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 195 include any changes in L<perldiag> that reconcile it to the C<C> code.
 196
 197 =head2 New Diagnostics
 198
 199 XXX Newly added diagnostic messages go under here, separated into New Errors
 200 and New Warnings
 201
 202 =head3 New Errors
 203
 204 =over 4
 205
 206 =item *
 207
 208 XXX L<message|perldiag/"message">
 209
 210 =back
 211
 212 =head3 New Warnings
 213
 214 =over 4
 215
 216 =item *
 217
 218 XXX L<message|perldiag/"message">
 219
 220 =back
 221
 222 =head2 Changes to Existing Diagnostics
 223
 224 XXX Changes (i.e. rewording) of diagnostic messages go here
 225
 226 =over 4
 227
 228 =item *
 229
 230 XXX Describe change here
 231
 232 =back
 233
 234 =head1 Utility Changes
 235
 236 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 237 Most of these are built within the directory F<utils>.
 238
 239 [ List utility changes as a =head2 entry for each utility and =item
 240 entries for each change
 241 Use L<XXX> with program names to get proper documentation linking. ]
 242
 243 =head2 L<XXX>
 244
 245 =over 4
 246
 247 =item *
 248
 249 XXX
 250
 251 =back
 252
 253 =head1 Configuration and Compilation
 254
 255 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 256 go here.  Any other changes to the Perl build process should be listed here.
 257 However, any platform-specific changes should be listed in the
 258 L</Platform Support> section, instead.
 259
 260 [ List changes as an =item entry ].
 261
 262 =over 4
 263
 264 =item *
 265
 266 XXX
 267
 268 =back
 269
 270 =head1 Testing
 271
 272 XXX Any significant changes to the testing of a freshly built perl should be
 273 listed here.  Changes which create B<new> files in F<t/> go here as do any
 274 large changes to the testing harness (e.g. when parallel testing was added).
 275 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 276 that they represent may be covered elsewhere.
 277
 278 XXX If there were no significant test changes, say this:
 279
 280 Tests were added and changed to reflect the other additions and changes
 281 in this release.
 282
 283 XXX If instead there were significant changes, say this:
 284
 285 Tests were added and changed to reflect the other additions and
 286 changes in this release.  Furthermore, these significant changes were
 287 made:
 288
 289 [ List each test improvement as an =item entry ]
 290
 291 =over 4
 292
 293 =item *
 294
 295 XXX
 296
 297 =back
 298
 299 =head1 Platform Support
 300
 301 XXX Any changes to platform support should be listed in the sections below.
 302
 303 [ Within the sections, list each platform as an =item entry with specific
 304 changes as paragraphs below it. ]
 305
 306 =head2 New Platforms
 307
 308 XXX List any platforms that this version of perl compiles on, that previous
 309 versions did not.  These will either be enabled by new files in the F<hints/>
 310 directories, or new subdirectories and F<README> files at the top level of the
 311 source tree.
 312
 313 =over 4
 314
 315 =item XXX-some-platform
 316
 317 XXX
 318
 319 =back
 320
 321 =head2 Discontinued Platforms
 322
 323 XXX List any platforms that this version of perl no longer compiles on.
 324
 325 =over 4
 326
 327 =item XXX-some-platform
 328
 329 XXX
 330
 331 =back
 332
 333 =head2 Platform-Specific Notes
 334
 335 XXX List any changes for specific platforms.  This could include configuration
 336 and compilation changes or changes in portability/compatibility.  However,
 337 changes within modules for platforms should generally be listed in the
 338 L</Modules and Pragmata> section.
 339
 340 =over 4
 341
 342 =item Win32
 343
 344 The locale tests could crash on Win32 due to a Windows bug, and
 345 separately due to the CRT throwing an exception if the locale name
 346 wasn't validly encoded in the current code page.
 347
 348 For the second we now decode the locale name ourselves, and always
 349 decode it as UTF-8.  [perl #133981]
 350
 351 =back
 352
 353 =head1 Internal Changes
 354
 355 XXX Changes which affect the interface available to C<XS> code go here.  Other
 356 significant internal changes for future core maintainers should be noted as
 357 well.
 358
 359 [ List each change as an =item entry ]
 360
 361 =over 4
 362
 363 =item *
 364
 365 XXX
 366
 367 =back
 368
 369 =head1 Selected Bug Fixes
 370
 371 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 372 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 373
 374 [ List each fix as an =item entry ]
 375
 376 =over 4
 377
 378 =item *
 379
 380 Perl no longer treats strings starting with "0x" or "0b" as hex or
 381 binary numbers respectively when converting a string to a number.
 382 This reverts a change in behaviour inadvertently introduced in perl
 383 5.30.0 intended to improve precision when converting a string to a
 384 floating point number. [perl #134230]
 385
 386 =item *
 387
 388 Matching a non-C<SVf_UTF8> string against a regular expression
 389 containing unicode literals could leak a SV on each match attempt.
 390 [perl #134390]
 391
 392 =back
 393
 394 =head1 Known Problems
 395
 396 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 397 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 398 platform specific bugs also go here.
 399
 400 [ List each fix as an =item entry ]
 401
 402 =over 4
 403
 404 =item *
 405
 406 XXX
 407
 408 =back
 409
 410 =head1 Errata From Previous Releases
 411
 412 =over 4
 413
 414 =item *
 415
 416 XXX Add anything here that we forgot to add, or were mistaken about, in
 417 the perldelta of a previous release.
 418
 419 =back
 420
 421 =head1 Obituary
 422
 423 XXX If any significant core contributor or member of the CPAN community has
 424 died, add a short obituary here.
 425
 426 =head1 Acknowledgements
 427
 428 XXX Generate this with:
 429
 430   perl Porting/acknowledgements.pl v5.31.3..HEAD
 431
 432 =head1 Reporting Bugs
 433
 434 If you find what you think is a bug, you might check the perl bug database
 435 at L<https://rt.perl.org/>.  There may also be information at
 436 L<http://www.perl.org/>, the Perl Home Page.
 437
 438 If you believe you have an unreported bug, please run the L<perlbug> program
 439 included with your release.  Be sure to trim your bug down to a tiny but
 440 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 441 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 442
 443 If the bug you are reporting has security implications which make it
 444 inappropriate to send to a publicly archived mailing list, then see
 445 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
 446 for details of how to report the issue.
 447
 448 =head1 Give Thanks
 449
 450 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
 451 you can do so by running the C<perlthanks> program:
 452
 453     perlthanks
 454
 455 This will send an email to the Perl 5 Porters list with your show of thanks.
 456
 457 =head1 SEE ALSO
 458
 459 The F<Changes> file for an explanation of how to view exhaustive details on
 460 what changed.
 461
 462 The F<INSTALL> file for how to build Perl.
 463
 464 The F<README> file for general stuff.
 465
 466 The F<Artistic> and F<Copying> files for copyright information.
 467
 468 =cut