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.21.3
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.21.2 release and the 5.21.3
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.21.1, first read
  16 L<perl5212delta>, which describes differences between 5.21.1 and 5.21.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 =head2 S<C<use UNIVERSAL '...'>> is now a fatal error
  49
  50 Importing functions from C<UNIVERSAL> has been deprecated since v5.12, and
  51 is now a fatal error.  S<C<"use UNIVERSAL">> without any arguments is still
  52 allowed.
  53
  54 =head1 Deprecations
  55
  56 XXX Any deprecated features, syntax, modules etc. should be listed here.
  57
  58 =head2 Module removals
  59
  60 XXX Remove this section if inapplicable.
  61
  62 The following modules will be removed from the core distribution in a
  63 future release, and will at that time need to be installed from CPAN.
  64 Distributions on CPAN which require these modules will need to list them as
  65 prerequisites.
  66
  67 The core versions of these modules will now issue C<"deprecated">-category
  68 warnings to alert you to this fact.  To silence these deprecation warnings,
  69 install the modules in question from CPAN.
  70
  71 Note that these are (with rare exceptions) fine modules that you are encouraged
  72 to continue to use.  Their disinclusion from core primarily hinges on their
  73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
  74 not usually on concerns over their design.
  75
  76 =over
  77
  78 =item XXX
  79
  80 XXX Note that deprecated modules should be listed here even if they are listed
  81 as an updated module in the L</Modules and Pragmata> section.
  82
  83 =back
  84
  85 [ List each other deprecation as a =head2 entry ]
  86
  87 =head1 Performance Enhancements
  88
  89 XXX Changes which enhance performance without changing behaviour go here.
  90 There may well be none in a stable release.
  91
  92 [ List each enhancement as a =item entry ]
  93
  94 =over 4
  95
  96 =item *
  97
  98 XXX
  99
 100 =back
 101
 102 =head1 Modules and Pragmata
 103
 104 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
 105 go here.  If Module::CoreList is updated, generate an initial draft of the
 106 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
 107 for important changes should then be added by hand.  In an ideal world,
 108 dual-life modules would have a F<Changes> file that could be cribbed.
 109
 110 [ Within each section, list entries as a =item entry ]
 111
 112 =head2 New Modules and Pragmata
 113
 114 =over 4
 115
 116 =item *
 117
 118 XXX
 119
 120 =back
 121
 122 =head2 Updated Modules and Pragmata
 123
 124 =over 4
 125
 126 =item *
 127
 128 L<XXX> has been upgraded from version A.xx to B.yy.
 129
 130 =back
 131
 132 =head2 Removed Modules and Pragmata
 133
 134 =over 4
 135
 136 =item *
 137
 138 XXX
 139
 140 =back
 141
 142 =head1 Documentation
 143
 144 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 145 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 146
 147 =head2 New Documentation
 148
 149 XXX Changes which create B<new> files in F<pod/> go here.
 150
 151 =head3 L<XXX>
 152
 153 XXX Description of the purpose of the new file here
 154
 155 =head2 Changes to Existing Documentation
 156
 157 XXX Changes which significantly change existing files in F<pod/> go here.
 158 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 159 section.
 160
 161 =head3 L<XXX>
 162
 163 =over 4
 164
 165 =item *
 166
 167 XXX Description of the change here
 168
 169 =back
 170
 171 =head1 Diagnostics
 172
 173 The following additions or changes have been made to diagnostic output,
 174 including warnings and fatal error messages.  For the complete list of
 175 diagnostic messages, see L<perldiag>.
 176
 177 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 178 include any changes in L<perldiag> that reconcile it to the C<C> code.
 179
 180 =head2 New Diagnostics
 181
 182 XXX Newly added diagnostic messages go under here, separated into New Errors
 183 and New Warnings
 184
 185 =head3 New Errors
 186
 187 =over 4
 188
 189 =item *
 190
 191 XXX L<message|perldiag/"message">
 192
 193 =back
 194
 195 =head3 New Warnings
 196
 197 =over 4
 198
 199 =item *
 200
 201 XXX L<message|perldiag/"message">
 202
 203 =back
 204
 205 =head2 Changes to Existing Diagnostics
 206
 207 XXX Changes (i.e. rewording) of diagnostic messages go here
 208
 209 =over 4
 210
 211 =item *
 212
 213 XXX Describe change here
 214
 215 =back
 216
 217 =head1 Utility Changes
 218
 219 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 220 Most of these are built within the directory F<utils>.
 221
 222 [ List utility changes as a =head2 entry for each utility and =item
 223 entries for each change
 224 Use L<XXX> with program names to get proper documentation linking. ]
 225
 226 =head2 L<XXX>
 227
 228 =over 4
 229
 230 =item *
 231
 232 XXX
 233
 234 =back
 235
 236 =head1 Configuration and Compilation
 237
 238 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 239 go here.  Any other changes to the Perl build process should be listed here.
 240 However, any platform-specific changes should be listed in the
 241 L</Platform Support> section, instead.
 242
 243 [ List changes as a =item entry ].
 244
 245 =over 4
 246
 247 =item *
 248
 249 XXX
 250
 251 =back
 252
 253 =head1 Testing
 254
 255 XXX Any significant changes to the testing of a freshly built perl should be
 256 listed here.  Changes which create B<new> files in F<t/> go here as do any
 257 large changes to the testing harness (e.g. when parallel testing was added).
 258 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 259 that they represent may be covered elsewhere.
 260
 261 [ List each test improvement as a =item entry ]
 262
 263 =over 4
 264
 265 =item *
 266
 267 XXX
 268
 269 =back
 270
 271 =head1 Platform Support
 272
 273 XXX Any changes to platform support should be listed in the sections below.
 274
 275 [ Within the sections, list each platform as a =item entry with specific
 276 changes as paragraphs below it. ]
 277
 278 =head2 New Platforms
 279
 280 XXX List any platforms that this version of perl compiles on, that previous
 281 versions did not.  These will either be enabled by new files in the F<hints/>
 282 directories, or new subdirectories and F<README> files at the top level of the
 283 source tree.
 284
 285 =over 4
 286
 287 =item XXX-some-platform
 288
 289 XXX
 290
 291 =back
 292
 293 =head2 Discontinued Platforms
 294
 295 XXX List any platforms that this version of perl no longer compiles on.
 296
 297 =over 4
 298
 299 =item XXX-some-platform
 300
 301 XXX
 302
 303 =back
 304
 305 =head2 Platform-Specific Notes
 306
 307 XXX List any changes for specific platforms.  This could include configuration
 308 and compilation changes or changes in portability/compatibility.  However,
 309 changes within modules for platforms should generally be listed in the
 310 L</Modules and Pragmata> section.
 311
 312 =over 4
 313
 314 =item XXX-some-platform
 315
 316 XXX
 317
 318 =back
 319
 320 =head1 Internal Changes
 321
 322 XXX Changes which affect the interface available to C<XS> code go here.  Other
 323 significant internal changes for future core maintainers should be noted as
 324 well.
 325
 326 [ List each change as a =item entry ]
 327
 328 =over 4
 329
 330 =item *
 331
 332 XXX
 333
 334 =back
 335
 336 =head1 Selected Bug Fixes
 337
 338 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 339 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 340
 341 [ List each fix as a =item entry ]
 342
 343 =over 4
 344
 345 =item *
 346
 347 Failing to compile C<use Foo> in an eval could leave a spurious
 348 C<BEGIN> subroutine definition, which would produce a "Subroutine
 349 BEGIN redefined" warning on the next use of C<use>, or other C<BEGIN>
 350 block.  [perl #122107]
 351
 352 =back
 353
 354 =head1 Known Problems
 355
 356 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 357 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 358 platform specific bugs also go here.
 359
 360 [ List each fix as a =item entry ]
 361
 362 =over 4
 363
 364 =item *
 365
 366 XXX
 367
 368 =back
 369
 370 =head1 Errata From Previous Releases
 371
 372 =over 4
 373
 374 =item *
 375
 376 XXX Add anything here that we forgot to add, or were mistaken about, in
 377 the perldelta of a previous release.
 378
 379 =back
 380
 381 =head1 Obituary
 382
 383 XXX If any significant core contributor has died, we've added a short obituary
 384 here.
 385
 386 =head1 Acknowledgements
 387
 388 XXX Generate this with:
 389
 390   perl Porting/acknowledgements.pl v5.21.2..HEAD
 391
 392 =head1 Reporting Bugs
 393
 394 If you find what you think is a bug, you might check the articles recently
 395 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
 396 https://rt.perl.org/ .  There may also be information at
 397 http://www.perl.org/ , the Perl Home Page.
 398
 399 If you believe you have an unreported bug, please run the L<perlbug> program
 400 included with your release.  Be sure to trim your bug down to a tiny but
 401 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 402 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 403
 404 If the bug you are reporting has security implications, which make it
 405 inappropriate to send to a publicly archived mailing list, then please send it
 406 to perl5-security-report@perl.org.  This points to a closed subscription
 407 unarchived mailing list, which includes all the core committers, who will be
 408 able to help assess the impact of issues, figure out a resolution, and help
 409 co-ordinate the release of patches to mitigate or fix the problem across all
 410 platforms on which Perl is supported.  Please only use this address for
 411 security issues in the Perl core, not for modules independently distributed on
 412 CPAN.
 413
 414 =head1 SEE ALSO
 415
 416 The F<Changes> file for an explanation of how to view exhaustive details on
 417 what changed.
 418
 419 The F<INSTALL> file for how to build Perl.
 420
 421 The F<README> file for general stuff.
 422
 423 The F<Artistic> and F<Copying> files for copyright information.
 424
 425 =cut