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.7
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.21.6 release and the 5.21.7
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.21.5, first read
  16 L<perl5216delta>, which describes differences between 5.21.5 and 5.21.6.
  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 inapplicable.
  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 =head2 Setting C<${^ENCODING}> to anything but C<undef>
  82
  83 This variable allows Perl scripts to be written in a non-ASCII,
  84 non-UTF-8 encoding.  However, it affects all modules globally, leading
  85 to wrong answers and segmentation faults.  New scripts should be written
  86 in UTF-8; old scripts should be converted to UTF-8, which is easily done
  87 with the L<encoding> pragma.
  88
  89 =head1 Performance Enhancements
  90
  91 XXX Changes which enhance performance without changing behaviour go here.
  92 There may well be none in a stable release.
  93
  94 [ List each enhancement as a =item entry ]
  95
  96 =over 4
  97
  98 =item *
  99
 100 XXX
 101
 102 =back
 103
 104 =head1 Modules and Pragmata
 105
 106 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
 107 go here.  If Module::CoreList is updated, generate an initial draft of the
 108 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
 109 for important changes should then be added by hand.  In an ideal world,
 110 dual-life modules would have a F<Changes> file that could be cribbed.
 111
 112 [ Within each section, list entries as a =item entry ]
 113
 114 =head2 New Modules and Pragmata
 115
 116 =over 4
 117
 118 =item *
 119
 120 XXX
 121
 122 =back
 123
 124 =head2 Updated Modules and Pragmata
 125
 126 =over 4
 127
 128 =item *
 129
 130 L<ExtUtils::ParseXS> has been upgraded from version 3.26 to 3.27.
 131
 132 Only declare C<file> unused if we actually define it.
 133
 134 Improve generated C<RETVAL> code generation to avoid repeated
 135 references to C<ST(0)>.  [perl #123278]
 136
 137 =item *
 138
 139 The PathTools module collection has been upgraded from 3.52 to 3.53.
 140
 141 Don't turn leading C<//> into C</> on Cygwin. [perl #122635]
 142
 143 =item *
 144
 145 L<Locale::Maketext> has been upgraded from version 1.25 to 1.26.
 146
 147 =item *
 148
 149 L<XSLoader> has been upgraded from version 0.19 to 0.20
 150
 151 Don't test twice for bootstrap file.
 152
 153 =back
 154
 155 =head2 Removed Modules and Pragmata
 156
 157 =over 4
 158
 159 =item *
 160
 161 XXX
 162
 163 =back
 164
 165 =head1 Documentation
 166
 167 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 168 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 169
 170 =head2 New Documentation
 171
 172 XXX Changes which create B<new> files in F<pod/> go here.
 173
 174 =head3 L<XXX>
 175
 176 XXX Description of the purpose of the new file here
 177
 178 =head2 Changes to Existing Documentation
 179
 180 XXX Changes which significantly change existing files in F<pod/> go here.
 181 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 182 section.
 183
 184 =head3 L<XXX>
 185
 186 =over 4
 187
 188 =item *
 189
 190 XXX Description of the change here
 191
 192 =back
 193
 194 =head1 Diagnostics
 195
 196 The following additions or changes have been made to diagnostic output,
 197 including warnings and fatal error messages.  For the complete list of
 198 diagnostic messages, see L<perldiag>.
 199
 200 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 201 include any changes in L<perldiag> that reconcile it to the C<C> code.
 202
 203 =head2 New Diagnostics
 204
 205 XXX Newly added diagnostic messages go under here, separated into New Errors
 206 and New Warnings
 207
 208 =head3 New Errors
 209
 210 =over 4
 211
 212 =item *
 213
 214 XXX L<message|perldiag/"message">
 215
 216 =back
 217
 218 =head3 New Warnings
 219
 220 =over 4
 221
 222 =item *
 223
 224 XXX L<message|perldiag/"message">
 225
 226 =back
 227
 228 =head2 Changes to Existing Diagnostics
 229
 230 XXX Changes (i.e. rewording) of diagnostic messages go here
 231
 232 =over 4
 233
 234 =item *
 235
 236 XXX Describe change here
 237
 238 =back
 239
 240 =head1 Utility Changes
 241
 242 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 243 Most of these are built within the directory F<utils>.
 244
 245 [ List utility changes as a =head2 entry for each utility and =item
 246 entries for each change
 247 Use L<XXX> with program names to get proper documentation linking. ]
 248
 249 =head2 L<XXX>
 250
 251 =over 4
 252
 253 =item *
 254
 255 XXX
 256
 257 =back
 258
 259 =head1 Configuration and Compilation
 260
 261 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 262 go here.  Any other changes to the Perl build process should be listed here.
 263 However, any platform-specific changes should be listed in the
 264 L</Platform Support> section, instead.
 265
 266 [ List changes as a =item entry ].
 267
 268 =over 4
 269
 270 =item *
 271
 272 XXX
 273
 274 =back
 275
 276 =head1 Testing
 277
 278 XXX Any significant changes to the testing of a freshly built perl should be
 279 listed here.  Changes which create B<new> files in F<t/> go here as do any
 280 large changes to the testing harness (e.g. when parallel testing was added).
 281 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 282 that they represent may be covered elsewhere.
 283
 284 [ List each test improvement as a =item entry ]
 285
 286 =over 4
 287
 288 =item *
 289
 290 XXX
 291
 292 =back
 293
 294 =head1 Platform Support
 295
 296 XXX Any changes to platform support should be listed in the sections below.
 297
 298 [ Within the sections, list each platform as a =item entry with specific
 299 changes as paragraphs below it. ]
 300
 301 =head2 New Platforms
 302
 303 XXX List any platforms that this version of perl compiles on, that previous
 304 versions did not.  These will either be enabled by new files in the F<hints/>
 305 directories, or new subdirectories and F<README> files at the top level of the
 306 source tree.
 307
 308 =over 4
 309
 310 =item XXX-some-platform
 311
 312 XXX
 313
 314 =back
 315
 316 =head2 Discontinued Platforms
 317
 318 XXX List any platforms that this version of perl no longer compiles on.
 319
 320 =over 4
 321
 322 =item XXX-some-platform
 323
 324 XXX
 325
 326 =back
 327
 328 =head2 Platform-Specific Notes
 329
 330 XXX List any changes for specific platforms.  This could include configuration
 331 and compilation changes or changes in portability/compatibility.  However,
 332 changes within modules for platforms should generally be listed in the
 333 L</Modules and Pragmata> section.
 334
 335 =over 4
 336
 337 =item XXX-some-platform
 338
 339 XXX
 340
 341 =back
 342
 343 =head1 Internal Changes
 344
 345 XXX Changes which affect the interface available to C<XS> code go here.  Other
 346 significant internal changes for future core maintainers should be noted as
 347 well.
 348
 349 [ List each change as a =item entry ]
 350
 351 =over 4
 352
 353 =item *
 354
 355 XXX
 356
 357 =back
 358
 359 =head1 Selected Bug Fixes
 360
 361 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 362 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 363
 364 [ List each fix as a =item entry ]
 365
 366 =over 4
 367
 368 =item *
 369
 370 On Win32, restoring in a child pseudo-process a variable that was
 371 C<local()>ed in a parent pseudo-process before the C<fork> happened caused
 372 memory corruption and a crash in the child pseudo-process (and therefore OS
 373 process).
 374
 375 =item *
 376
 377 The L<encoding> pragma's effect is now limited to lexical scope.  This
 378 pragma is deprecated, but in the meantime, it could adversely affect
 379 unrelated modules that are included in the same program.
 380
 381 =back
 382
 383 =head1 Known Problems
 384
 385 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 386 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 387 platform specific bugs also go here.
 388
 389 [ List each fix as a =item entry ]
 390
 391 =over 4
 392
 393 =item *
 394
 395 XXX
 396
 397 =back
 398
 399 =head1 Errata From Previous Releases
 400
 401 =over 4
 402
 403 =item *
 404
 405 XXX Add anything here that we forgot to add, or were mistaken about, in
 406 the perldelta of a previous release.
 407
 408 =back
 409
 410 =head1 Obituary
 411
 412 XXX If any significant core contributor has died, we've added a short obituary
 413 here.
 414
 415 =head1 Acknowledgements
 416
 417 XXX Generate this with:
 418
 419   perl Porting/acknowledgements.pl v5.21.6..HEAD
 420
 421 =head1 Reporting Bugs
 422
 423 If you find what you think is a bug, you might check the articles recently
 424 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
 425 https://rt.perl.org/ .  There may also be information at
 426 http://www.perl.org/ , the Perl Home Page.
 427
 428 If you believe you have an unreported bug, please run the L<perlbug> program
 429 included with your release.  Be sure to trim your bug down to a tiny but
 430 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 431 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 432
 433 If the bug you are reporting has security implications, which make it
 434 inappropriate to send to a publicly archived mailing list, then please send it
 435 to perl5-security-report@perl.org.  This points to a closed subscription
 436 unarchived mailing list, which includes all the core committers, who will be
 437 able to help assess the impact of issues, figure out a resolution, and help
 438 co-ordinate the release of patches to mitigate or fix the problem across all
 439 platforms on which Perl is supported.  Please only use this address for
 440 security issues in the Perl core, not for modules independently distributed on
 441 CPAN.
 442
 443 =head1 SEE ALSO
 444
 445 The F<Changes> file for an explanation of how to view exhaustive details on
 446 what changed.
 447
 448 The F<INSTALL> file for how to build Perl.
 449
 450 The F<README> file for general stuff.
 451
 452 The F<Artistic> and F<Copying> files for copyright information.
 453
 454 =cut