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.39.0
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.38.0 release and the 5.39.0
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.38.0, first read
  16 L<perl5380delta>, which describes differences between 5.38.0 and 5.38.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 =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 Porting/corelist-perldelta.pl did not add any content here.
 119
 120 =back
 121
 122 =head2 Updated Modules and Pragmata
 123
 124 =over 4
 125
 126 =item *
 127
 128 L<Errno> has been upgraded from version 1.37 to 1.38.
 129
 130 The C<osvers> and C<archname> baked into the module to ensure Errno is
 131 loaded by the perl that built it are now more comprehensively
 132 escaped. [GH #21135]
 133
 134 =back
 135
 136 =head2 Removed Modules and Pragmata
 137
 138 =over 4
 139
 140 =item *
 141
 142 XXX Remove this section if Porting/corelist-perldelta.pl did not add any content here.
 143
 144 =back
 145
 146 =head1 Documentation
 147
 148 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 149 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 150
 151 =head2 New Documentation
 152
 153 XXX Changes which create B<new> files in F<pod/> go here.
 154
 155 =head3 L<XXX>
 156
 157 XXX Description of the purpose of the new file here
 158
 159 =head2 Changes to Existing Documentation
 160
 161 We have attempted to update the documentation to reflect the changes
 162 listed in this document.  If you find any we have missed, open an issue
 163 at L<https://github.com/Perl/perl5/issues>.
 164
 165 XXX Changes which significantly change existing files in F<pod/> go here.
 166 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 167 section.
 168
 169 Additionally, the following selected changes have been made:
 170
 171 =head3 L<XXX>
 172
 173 =over 4
 174
 175 =item *
 176
 177 XXX Description of the change here
 178
 179 =back
 180
 181 =head1 Diagnostics
 182
 183 The following additions or changes have been made to diagnostic output,
 184 including warnings and fatal error messages.  For the complete list of
 185 diagnostic messages, see L<perldiag>.
 186
 187 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 188 include any changes in L<perldiag> that reconcile it to the C<C> code.
 189
 190 =head2 New Diagnostics
 191
 192 XXX Newly added diagnostic messages go under here, separated into New Errors
 193 and New Warnings
 194
 195 =head3 New Errors
 196
 197 =over 4
 198
 199 =item *
 200
 201 XXX L<message|perldiag/"message">
 202
 203 =back
 204
 205 =head3 New Warnings
 206
 207 =over 4
 208
 209 =item *
 210
 211 XXX L<message|perldiag/"message">
 212
 213 =back
 214
 215 =head2 Changes to Existing Diagnostics
 216
 217 XXX Changes (i.e. rewording) of diagnostic messages go here
 218
 219 =over 4
 220
 221 =item *
 222
 223 XXX Describe change here
 224
 225 =back
 226
 227 =head1 Utility Changes
 228
 229 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
 230 Most of these are built within the directory F<utils>.
 231
 232 [ List utility changes as a =head2 entry for each utility and =item
 233 entries for each change
 234 Use L<XXX> with program names to get proper documentation linking. ]
 235
 236 =head2 L<XXX>
 237
 238 =over 4
 239
 240 =item *
 241
 242 XXX
 243
 244 =back
 245
 246 =head1 Configuration and Compilation
 247
 248 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 249 go here.  Any other changes to the Perl build process should be listed here.
 250 However, any platform-specific changes should be listed in the
 251 L</Platform Support> section, instead.
 252
 253 [ List changes as an =item entry ].
 254
 255 =over 4
 256
 257 =item *
 258
 259 XXX
 260
 261 =back
 262
 263 =head1 Testing
 264
 265 XXX Any significant changes to the testing of a freshly built perl should be
 266 listed here.  Changes which create B<new> files in F<t/> go here as do any
 267 large changes to the testing harness (e.g. when parallel testing was added).
 268 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 269 that they represent may be covered elsewhere.
 270
 271 XXX If there were no significant test changes, say this:
 272
 273 Tests were added and changed to reflect the other additions and changes
 274 in this release.
 275
 276 XXX If instead there were significant changes, say this:
 277
 278 Tests were added and changed to reflect the other additions and
 279 changes in this release.  Furthermore, these significant changes were
 280 made:
 281
 282 [ List each test improvement as an =item entry ]
 283
 284 =over 4
 285
 286 =item *
 287
 288 XXX
 289
 290 =back
 291
 292 =head1 Platform Support
 293
 294 XXX Any changes to platform support should be listed in the sections below.
 295
 296 [ Within the sections, list each platform as an =item entry with specific
 297 changes as paragraphs below it. ]
 298
 299 =head2 New Platforms
 300
 301 XXX List any platforms that this version of perl compiles on, that previous
 302 versions did not.  These will either be enabled by new files in the F<hints/>
 303 directories, or new subdirectories and F<README> files at the top level of the
 304 source tree.
 305
 306 =over 4
 307
 308 =item XXX-some-platform
 309
 310 XXX
 311
 312 =back
 313
 314 =head2 Discontinued Platforms
 315
 316 XXX List any platforms that this version of perl no longer compiles on.
 317
 318 =over 4
 319
 320 =item XXX-some-platform
 321
 322 XXX
 323
 324 =back
 325
 326 =head2 Platform-Specific Notes
 327
 328 XXX List any changes for specific platforms.  This could include configuration
 329 and compilation changes or changes in portability/compatibility.  However,
 330 changes within modules for platforms should generally be listed in the
 331 L</Modules and Pragmata> section.
 332
 333 =over 4
 334
 335 =item XXX-some-platform
 336
 337 XXX
 338
 339 =back
 340
 341 =head1 Internal Changes
 342
 343 XXX Changes which affect the interface available to C<XS> code go here.  Other
 344 significant internal changes for future core maintainers should be noted as
 345 well.
 346
 347 [ List each change as an =item entry ]
 348
 349 =over 4
 350
 351 =item *
 352
 353 XXX
 354
 355 =back
 356
 357 =head1 Selected Bug Fixes
 358
 359 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 360 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 361
 362 Include references to GitHub issues and PRs as: [GH #12345] and the release
 363 manager will later use a regex to expand these into links.
 364
 365 [ List each fix as an =item entry ]
 366
 367 =over 4
 368
 369 =item *
 370
 371 XXX
 372
 373 =back
 374
 375 =head1 Known Problems
 376
 377 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 378 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 379 platform specific bugs also go here.
 380
 381 [ List each fix as an =item entry ]
 382
 383 =over 4
 384
 385 =item *
 386
 387 XXX
 388
 389 =back
 390
 391 =head1 Errata From Previous Releases
 392
 393 =over 4
 394
 395 =item *
 396
 397 XXX Add anything here that we forgot to add, or were mistaken about, in
 398 the perldelta of a previous release.
 399
 400 =back
 401
 402 =head1 Obituary
 403
 404 XXX If any significant core contributor or member of the CPAN community has
 405 died, add a short obituary here.
 406
 407 =head1 Acknowledgements
 408
 409 XXX Generate this with:
 410
 411   perl Porting/acknowledgements.pl v5.37.12..HEAD
 412
 413 =head1 Reporting Bugs
 414
 415 If you find what you think is a bug, you might check the perl bug database
 416 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
 417 L<http://www.perl.org/>, the Perl Home Page.
 418
 419 If you believe you have an unreported bug, please open an issue at
 420 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
 421 tiny but sufficient test case.
 422
 423 If the bug you are reporting has security implications which make it
 424 inappropriate to send to a public issue tracker, then see
 425 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
 426 for details of how to report the issue.
 427
 428 =head1 Give Thanks
 429
 430 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
 431 you can do so by running the C<perlthanks> program:
 432
 433     perlthanks
 434
 435 This will send an email to the Perl 5 Porters list with your show of thanks.
 436
 437 =head1 SEE ALSO
 438
 439 The F<Changes> file for an explanation of how to view exhaustive details on
 440 what changed.
 441
 442 The F<INSTALL> file for how to build Perl.
 443
 444 The F<README> file for general stuff.
 445
 446 The F<Artistic> and F<Copying> files for copyright information.
 447
 448 =cut