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