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.5
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.31.4 release and the 5.31.5
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.31.3, first read
  16 L<perl5314delta>, which describes differences between 5.31.3 and 5.31.4.
  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 =head2 Modifiable variables are no longer permitted in constants
  49
  50 Code like:
  51
  52     my $var;
  53     $sub = sub () { $var };
  54
  55 where C<$var> is referenced elsewhere in some sort of modiable context
  56 now produces an exception when the sub is defined.
  57
  58 This error can be avoided by adding a return to the sub definition:
  59
  60     $sub = sub () { return $var };
  61
  62 This has been deprecated since perl 5.22.
  63
  64 [perl #131138]
  65
  66 =head1 Deprecations
  67
  68 XXX Any deprecated features, syntax, modules etc. should be listed here.
  69
  70 =head2 Module removals
  71
  72 XXX Remove this section if not applicable.
  73
  74 The following modules will be removed from the core distribution in a
  75 future release, and will at that time need to be installed from CPAN.
  76 Distributions on CPAN which require these modules will need to list them as
  77 prerequisites.
  78
  79 The core versions of these modules will now issue C<"deprecated">-category
  80 warnings to alert you to this fact.  To silence these deprecation warnings,
  81 install the modules in question from CPAN.
  82
  83 Note that these are (with rare exceptions) fine modules that you are encouraged
  84 to continue to use.  Their disinclusion from core primarily hinges on their
  85 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
  86 not usually on concerns over their design.
  87
  88 =over
  89
  90 =item XXX
  91
  92 XXX Note that deprecated modules should be listed here even if they are listed
  93 as an updated module in the L</Modules and Pragmata> section.
  94
  95 =back
  96
  97 [ List each other deprecation as a =head2 entry ]
  98
  99 =head1 Performance Enhancements
 100
 101 XXX Changes which enhance performance without changing behaviour go here.
 102 There may well be none in a stable release.
 103
 104 [ List each enhancement as an =item entry ]
 105
 106 =over 4
 107
 108 =item *
 109
 110 XXX
 111
 112 =back
 113
 114 =head1 Modules and Pragmata
 115
 116 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
 117 go here.  If Module::CoreList is updated, generate an initial draft of the
 118 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
 119 for important changes should then be added by hand.  In an ideal world,
 120 dual-life modules would have a F<Changes> file that could be cribbed.
 121
 122 The list of new and updated modules is modified automatically as part of
 123 preparing a Perl release, so the only reason to manually add entries here is if
 124 you're summarising the important changes in the module update. (Also, if the
 125 manually-added details don't match the automatically-generated ones, the
 126 release manager will have to investigate the situation carefully.)
 127
 128 [ Within each section, list entries as an =item entry ]
 129
 130 =head2 New Modules and Pragmata
 131
 132 =over 4
 133
 134 =item *
 135
 136 XXX Remove this section if not applicable.
 137
 138 =back
 139
 140 =head2 Updated Modules and Pragmata
 141
 142 =over 4
 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 Perl now no longer probes for C<d_u32align>, defaulting to C<define>
 276 on all platforms.  This check was error prone when it was done, which
 277 was on 32-bit platforms only.  [perl #133495]
 278
 279 =back
 280
 281 =head1 Testing
 282
 283 XXX Any significant changes to the testing of a freshly built perl should be
 284 listed here.  Changes which create B<new> files in F<t/> go here as do any
 285 large changes to the testing harness (e.g. when parallel testing was added).
 286 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 287 that they represent may be covered elsewhere.
 288
 289 XXX If there were no significant test changes, say this:
 290
 291 Tests were added and changed to reflect the other additions and changes
 292 in this release.
 293
 294 XXX If instead there were significant changes, say this:
 295
 296 Tests were added and changed to reflect the other additions and
 297 changes in this release.  Furthermore, these significant changes were
 298 made:
 299
 300 [ List each test improvement as an =item entry ]
 301
 302 =over 4
 303
 304 =item *
 305
 306 XXX
 307
 308 =back
 309
 310 =head1 Platform Support
 311
 312 XXX Any changes to platform support should be listed in the sections below.
 313
 314 [ Within the sections, list each platform as an =item entry with specific
 315 changes as paragraphs below it. ]
 316
 317 =head2 New Platforms
 318
 319 XXX List any platforms that this version of perl compiles on, that previous
 320 versions did not.  These will either be enabled by new files in the F<hints/>
 321 directories, or new subdirectories and F<README> files at the top level of the
 322 source tree.
 323
 324 =over 4
 325
 326 =item XXX-some-platform
 327
 328 XXX
 329
 330 =back
 331
 332 =head2 Discontinued Platforms
 333
 334 XXX List any platforms that this version of perl no longer compiles on.
 335
 336 =over 4
 337
 338 =item XXX-some-platform
 339
 340 XXX
 341
 342 =back
 343
 344 =head2 Platform-Specific Notes
 345
 346 XXX List any changes for specific platforms.  This could include configuration
 347 and compilation changes or changes in portability/compatibility.  However,
 348 changes within modules for platforms should generally be listed in the
 349 L</Modules and Pragmata> section.
 350
 351 =over 4
 352
 353 =item XXX-some-platform
 354
 355 XXX
 356
 357 =back
 358
 359 =head1 Internal Changes
 360
 361 XXX Changes which affect the interface available to C<XS> code go here.  Other
 362 significant internal changes for future core maintainers should be noted as
 363 well.
 364
 365 [ List each change as an =item entry ]
 366
 367 =over 4
 368
 369 =item *
 370
 371 Added the C<<PL_curstackinfo->si_cxsubix>> field. This records the stack
 372 index of the most recently pushed sub/format/eval context.  It is set and
 373 restored automatically by C<cx_pushsub()>, C<cx_popsub()> etc., but would
 374 need to be manually managed if you do any unusual manipulation of the
 375 context stack.
 376
 377 =item *
 378
 379 Various macros dealing with character type classification and changing
 380 case where the input is encoded in UTF-8 now require an extra parameter
 381 to prevent potential reads beyond the end of the buffer.  Use of these
 382 has generated a deprecation warning since 5.26.  Details are in
 383 L<perldeprecation/In XS code, use of various macros dealing with UTF-8.>
 384
 385 =back
 386
 387 =head1 Selected Bug Fixes
 388
 389 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 390 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 391
 392 [ List each fix as an =item entry ]
 393
 394 =over 4
 395
 396 =item *
 397
 398 XXX
 399
 400 =back
 401
 402 =head1 Known Problems
 403
 404 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 405 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 406 platform specific bugs also go here.
 407
 408 [ List each fix as an =item entry ]
 409
 410 =over 4
 411
 412 =item *
 413
 414 XXX
 415
 416 =back
 417
 418 =head1 Errata From Previous Releases
 419
 420 =over 4
 421
 422 =item *
 423
 424 XXX Add anything here that we forgot to add, or were mistaken about, in
 425 the perldelta of a previous release.
 426
 427 =back
 428
 429 =head1 Obituary
 430
 431 XXX If any significant core contributor or member of the CPAN community has
 432 died, add a short obituary here.
 433
 434 =head1 Acknowledgements
 435
 436 XXX Generate this with:
 437
 438   perl Porting/acknowledgements.pl v5.31.4..HEAD
 439
 440 =head1 Reporting Bugs
 441
 442 If you find what you think is a bug, you might check the perl bug database
 443 at L<https://rt.perl.org/>.  There may also be information at
 444 L<https://www.perl.org/>, the Perl Home Page.
 445
 446 If you believe you have an unreported bug, please run the L<perlbug> program
 447 included with your release.  Be sure to trim your bug down to a tiny but
 448 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 449 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 450
 451 If the bug you are reporting has security implications which make it
 452 inappropriate to send to a publicly archived mailing list, then see
 453 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
 454 for details of how to report the issue.
 455
 456 =head1 Give Thanks
 457
 458 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
 459 you can do so by running the C<perlthanks> program:
 460
 461     perlthanks
 462
 463 This will send an email to the Perl 5 Porters list with your show of thanks.
 464
 465 =head1 SEE ALSO
 466
 467 The F<Changes> file for an explanation of how to view exhaustive details on
 468 what changed.
 469
 470 The F<INSTALL> file for how to build Perl.
 471
 472 The F<README> file for general stuff.
 473
 474 The F<Artistic> and F<Copying> files for copyright information.
 475
 476 =cut