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