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.33.7
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.33.6 release and the 5.33.7
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.33.5, first read
  16 L<perl5336delta>, which describes differences between 5.33.5 and 5.33.6.
  17
  18 =head1 Notice
  19
  20 XXX Any important notices here
  21
  22 =head1 Core Enhancements
  23
  24 =head2 Experimental Try/Catch Syntax
  25
  26 An initial experimental attempt at providing C<try>/C<catch> notation has
  27 been added.
  28
  29     use feature 'try';
  30
  31     try {
  32         a_function();
  33     }
  34     catch ($e) {
  35         warn "An error occurred: $e";
  36     }
  37
  38 For more information, see L<perlsyn/"Try Catch Exception Handling">.
  39
  40 [ List each enhancement as a =head2 entry ]
  41
  42 =head1 Security
  43
  44 XXX Any security-related notices go here.  In particular, any security
  45 vulnerabilities closed should be noted here rather than in the
  46 L</Selected Bug Fixes> section.
  47
  48 [ List each security issue as a =head2 entry ]
  49
  50 =head1 Incompatible Changes
  51
  52 XXX For a release on a stable branch, this section aspires to be:
  53
  54     There are no changes intentionally incompatible with 5.XXX.XXX
  55     If any exist, they are bugs, and we request that you submit a
  56     report.  See L</Reporting Bugs> below.
  57
  58 [ List each incompatible change as a =head2 entry ]
  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 XXX
 105
 106 =back
 107
 108 =head1 Modules and Pragmata
 109
 110 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
 111 go here.  If Module::CoreList is updated, generate an initial draft of the
 112 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
 113 for important changes should then be added by hand.  In an ideal world,
 114 dual-life modules would have a F<Changes> file that could be cribbed.
 115
 116 The list of new and updated modules is modified automatically as part of
 117 preparing a Perl release, so the only reason to manually add entries here is if
 118 you're summarising the important changes in the module update. (Also, if the
 119 manually-added details don't match the automatically-generated ones, the
 120 release manager will have to investigate the situation carefully.)
 121
 122 [ Within each section, list entries as an =item entry ]
 123
 124 =head2 New Modules and Pragmata
 125
 126 =over 4
 127
 128 =item *
 129
 130 XXX Remove this section if not applicable.
 131
 132 =back
 133
 134 =head2 Updated Modules and Pragmata
 135
 136 =over 4
 137
 138 =item *
 139
 140 L<XXX> has been upgraded from version A.xx to B.yy.
 141
 142 If there was something important to note about this change, include that here.
 143
 144 =back
 145
 146 =head2 Removed Modules and Pragmata
 147
 148 =over 4
 149
 150 =item *
 151
 152 XXX
 153
 154 =back
 155
 156 =head1 Documentation
 157
 158 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 159 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 160
 161 =head2 New Documentation
 162
 163 XXX Changes which create B<new> files in F<pod/> go here.
 164
 165 =head3 L<XXX>
 166
 167 XXX Description of the purpose of the new file here
 168
 169 =head2 Changes to Existing Documentation
 170
 171 We have attempted to update the documentation to reflect the changes
 172 listed in this document.  If you find any we have missed, open an issue
 173 at L<https://github.com/Perl/perl5/issues>.
 174
 175 XXX Changes which significantly change existing files in F<pod/> go here.
 176 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 177 section.
 178
 179 Additionally, the following selected changes have been made:
 180
 181 =head3 L<perlfunc>
 182
 183 =over 4
 184
 185 =item *
 186
 187 L<my()|perlfunc/my> and L<state()|perlfunc/state> now explicitly warn
 188 the reader that lexical variables should typically not be redeclared
 189 within the same scope or statement.
 190 L<[#18389]|https://github.com/Perl/perl5/issues/18389>
 191
 192 =back
 193
 194 =head3 L<XXX>
 195
 196 =over 4
 197
 198 =item *
 199
 200 XXX Description of the change here
 201
 202 =back
 203
 204 =head1 Diagnostics
 205
 206 The following additions or changes have been made to diagnostic output,
 207 including warnings and fatal error messages.  For the complete list of
 208 diagnostic messages, see L<perldiag>.
 209
 210 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 211 include any changes in L<perldiag> that reconcile it to the C<C> code.
 212
 213 =head2 New Diagnostics
 214
 215 XXX Newly added diagnostic messages go under here, separated into New Errors
 216 and New Warnings
 217
 218 =head3 New Errors
 219
 220 =over 4
 221
 222 =item *
 223
 224 XXX L<message|perldiag/"message">
 225
 226 =back
 227
 228 =head3 New Warnings
 229
 230 =over 4
 231
 232 =item *
 233
 234 XXX L<message|perldiag/"message">
 235
 236 =back
 237
 238 =head2 Changes to Existing Diagnostics
 239
 240 XXX Changes (i.e. rewording) of diagnostic messages go here
 241
 242 =over 4
 243
 244 =item *
 245
 246 XXX Describe change here
 247
 248 =back
 249
 250 =head1 Utility Changes
 251
 252 XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
 253 Most of these are built within the directory F<utils>.
 254
 255 [ List utility changes as a =head2 entry for each utility and =item
 256 entries for each change
 257 Use L<XXX> with program names to get proper documentation linking. ]
 258
 259 =head2 L<XXX>
 260
 261 =over 4
 262
 263 =item *
 264
 265 XXX
 266
 267 =back
 268
 269 =head1 Configuration and Compilation
 270
 271 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 272 go here.  Any other changes to the Perl build process should be listed here.
 273 However, any platform-specific changes should be listed in the
 274 L</Platform Support> section, instead.
 275
 276 [ List changes as an =item entry ].
 277
 278 =over 4
 279
 280 =item *
 281
 282 XXX
 283
 284 =back
 285
 286 =head1 Testing
 287
 288 XXX Any significant changes to the testing of a freshly built perl should be
 289 listed here.  Changes which create B<new> files in F<t/> go here as do any
 290 large changes to the testing harness (e.g. when parallel testing was added).
 291 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 292 that they represent may be covered elsewhere.
 293
 294 XXX If there were no significant test changes, say this:
 295
 296 Tests were added and changed to reflect the other additions and changes
 297 in this release.
 298
 299 XXX If instead there were significant changes, say this:
 300
 301 Tests were added and changed to reflect the other additions and
 302 changes in this release.  Furthermore, these significant changes were
 303 made:
 304
 305 [ List each test improvement as an =item entry ]
 306
 307 =over 4
 308
 309 =item *
 310
 311 XXX
 312
 313 =back
 314
 315 =head1 Platform Support
 316
 317 XXX Any changes to platform support should be listed in the sections below.
 318
 319 [ Within the sections, list each platform as an =item entry with specific
 320 changes as paragraphs below it. ]
 321
 322 =head2 New Platforms
 323
 324 XXX List any platforms that this version of perl compiles on, that previous
 325 versions did not.  These will either be enabled by new files in the F<hints/>
 326 directories, or new subdirectories and F<README> files at the top level of the
 327 source tree.
 328
 329 =over 4
 330
 331 =item XXX-some-platform
 332
 333 XXX
 334
 335 =back
 336
 337 =head2 Discontinued Platforms
 338
 339 XXX List any platforms that this version of perl no longer compiles on.
 340
 341 =over 4
 342
 343 =item XXX-some-platform
 344
 345 XXX
 346
 347 =back
 348
 349 =head2 Platform-Specific Notes
 350
 351 XXX List any changes for specific platforms.  This could include configuration
 352 and compilation changes or changes in portability/compatibility.  However,
 353 changes within modules for platforms should generally be listed in the
 354 L</Modules and Pragmata> section.
 355
 356 =over 4
 357
 358 =item Windows
 359
 360 Building with mingw.org compilers (version 3.4.5 or later) using mingw runtime
 361 versions < 3.22 now works again.  This was broken in Perl 5.31.4.
 362
 363 Building with mingw.org compilers (version 3.4.5 or later) using mingw runtime
 364 versions >= 3.21 now works (for compilers up to version 5.3.0).
 365
 366 Makefile.mk, and thus support for dmake, has been removed. It is still possible
 367 to build Perl on Windows using nmake (Makefile) and GNU make (GNUmakefile).
 368 [L<GH #18511|https://github.com/Perl/perl5/pull/18511>]
 369
 370 =back
 371
 372 =head1 Internal Changes
 373
 374 XXX Changes which affect the interface available to C<XS> code go here.  Other
 375 significant internal changes for future core maintainers should be noted as
 376 well.
 377
 378 [ List each change as an =item entry ]
 379
 380 =over 4
 381
 382 =item *
 383
 384 XXX
 385
 386 =back
 387
 388 =head1 Selected Bug Fixes
 389
 390 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 391 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 392
 393 [ List each fix as an =item entry ]
 394
 395 =over 4
 396
 397 =item *
 398
 399 XXX
 400
 401 =back
 402
 403 =head1 Known Problems
 404
 405 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 406 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 407 platform specific bugs also go here.
 408
 409 [ List each fix as an =item entry ]
 410
 411 =over 4
 412
 413 =item *
 414
 415 XXX
 416
 417 =back
 418
 419 =head1 Errata From Previous Releases
 420
 421 =over 4
 422
 423 =item *
 424
 425 XXX Add anything here that we forgot to add, or were mistaken about, in
 426 the perldelta of a previous release.
 427
 428 =back
 429
 430 =head1 Obituary
 431
 432 XXX If any significant core contributor or member of the CPAN community has
 433 died, add a short obituary here.
 434
 435 =head1 Acknowledgements
 436
 437 XXX Generate this with:
 438
 439   perl Porting/acknowledgements.pl v5.33.6..HEAD
 440
 441 =head1 Reporting Bugs
 442
 443 If you find what you think is a bug, you might check the perl bug database
 444 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
 445 L<http://www.perl.org/>, the Perl Home Page.
 446
 447 If you believe you have an unreported bug, please open an issue at
 448 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
 449 tiny but sufficient test case.
 450
 451 If the bug you are reporting has security implications which make it
 452 inappropriate to send to a public issue tracker, 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