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