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