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.25.9
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.25.8 release and the 5.25.9
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.25.7, first read
  16 L<perl5258delta>, which describes differences between 5.25.7 and 5.25.8.
  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 =head2 String delimiters that aren't stand-alone graphemes are now
  51 deprecated
  52
  53 In order for Perl to eventually allow string delimiters to be Unicode
  54 grapheme clusters (which look like a single character, but may be
  55 a sequence of several ones), we have to stop allowing a single char
  56 delimiter that isn't a grapheme by itself.  These are unlikely to exist
  57 in actual code, as they would typically display as attached to the
  58 character in front of them.
  59
  60 =head2 Module removals
  61
  62 XXX Remove this section if inapplicable.
  63
  64 The following modules will be removed from the core distribution in a
  65 future release, and will at that time need to be installed from CPAN.
  66 Distributions on CPAN which require these modules will need to list them as
  67 prerequisites.
  68
  69 The core versions of these modules will now issue C<"deprecated">-category
  70 warnings to alert you to this fact.  To silence these deprecation warnings,
  71 install the modules in question from CPAN.
  72
  73 Note that these are (with rare exceptions) fine modules that you are encouraged
  74 to continue to use.  Their disinclusion from core primarily hinges on their
  75 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
  76 not usually on concerns over their design.
  77
  78 =over
  79
  80 =item XXX
  81
  82 XXX Note that deprecated modules should be listed here even if they are listed
  83 as an updated module in the L</Modules and Pragmata> section.
  84
  85 =back
  86
  87 [ List each other deprecation as a =head2 entry ]
  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<XXX> has been upgraded from version A.xx to B.yy.
 131
 132 =item *
 133
 134 L<B::Xref> has been upgraded from version 1.05 to 1.06.
 135
 136 =item *
 137
 138 L<VMS-DCLsym::DCLsym> has been upgraded from version 1.07 to 1.08.
 139
 140 =item *
 141
 142 L<diagnostics> has been upgraded from version 1.35 to 1.36.
 143
 144 =item *
 145
 146 L<Devel::SelfStubber> has been upgraded from version 1.05 to 1.06.
 147
 148 =item *
 149
 150 L<DynaLoader> has been upgraded from version 1.40 to 1.41.
 151
 152 =item *
 153
 154 L<Errno> has been upgraded from version 1.27 to 1.28.
 155
 156 =item *
 157
 158 L<ExtUtils::Embed> has been upgraded from version 1.33 to 1.34.
 159
 160 =item *
 161
 162 L<I18N::LangTags> has been upgraded from version 0.41 to 0.42.
 163
 164 =item *
 165
 166 L<lib> has been upgraded from version 0.63 to 0.64.
 167
 168 =item *
 169
 170 L<Module::CoreList> has been upgraded from version 5.20161220 to 5.20170120.
 171
 172 =item *
 173
 174 L<OS2-Process::Process> has been upgraded from version 1.11 to 1.12.
 175
 176 =item *
 177
 178 L<perl5db.pl> has been upgraded from version 1.50 to 1.51.
 179
 180 =item *
 181
 182 L<Storable> has been upgraded from version 2.59 to 2.60.
 183
 184 =item *
 185
 186 L<Symbol> has been upgraded from version 1.07 to 1.08.
 187
 188 =item *
 189
 190 L<Term::ReadLine> has been upgraded from version 1.15 to 1.16.
 191
 192 =item *
 193
 194 L<Test> has been upgraded from version 1.29 to 1.30.
 195
 196 =item *
 197
 198 L<Unicode::UCD> has been upgraded from version 0.67 to 0.68.
 199
 200 =item *
 201
 202 L<XSLoader> has been upgraded from version 0.24 to 0.26.
 203
 204 =back
 205
 206 =head2 Removed Modules and Pragmata
 207
 208 =over 4
 209
 210 =item *
 211
 212 XXX
 213
 214 =back
 215
 216 =head1 Documentation
 217
 218 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 219 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 220
 221 =head2 New Documentation
 222
 223 XXX Changes which create B<new> files in F<pod/> go here.
 224
 225 =head3 L<XXX>
 226
 227 XXX Description of the purpose of the new file here
 228
 229 =head2 Changes to Existing Documentation
 230
 231 XXX Changes which significantly change existing files in F<pod/> go here.
 232 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 233 section.
 234
 235 =head3 L<XXX>
 236
 237 =over 4
 238
 239 =item *
 240
 241 XXX Description of the change here
 242
 243 =back
 244
 245 =head1 Diagnostics
 246
 247 The following additions or changes have been made to diagnostic output,
 248 including warnings and fatal error messages.  For the complete list of
 249 diagnostic messages, see L<perldiag>.
 250
 251 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 252 include any changes in L<perldiag> that reconcile it to the C<C> code.
 253
 254 =head2 New Diagnostics
 255
 256 XXX Newly added diagnostic messages go under here, separated into New Errors
 257 and New Warnings
 258
 259 =head3 New Errors
 260
 261 =over 4
 262
 263 =item *
 264
 265 XXX L<message|perldiag/"message">
 266
 267 =back
 268
 269 =head3 New Warnings
 270
 271 =over 4
 272
 273 =item *
 274
 275 XXX L<message|perldiag/"message">
 276
 277 =back
 278
 279 =head2 Changes to Existing Diagnostics
 280
 281 XXX Changes (i.e. rewording) of diagnostic messages go here
 282
 283 =over 4
 284
 285 =item *
 286
 287 XXX Describe change here
 288
 289 =back
 290
 291 =head1 Utility Changes
 292
 293 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 294 Most of these are built within the directory F<utils>.
 295
 296 [ List utility changes as a =head2 entry for each utility and =item
 297 entries for each change
 298 Use L<XXX> with program names to get proper documentation linking. ]
 299
 300 =head2 L<XXX>
 301
 302 =over 4
 303
 304 =item *
 305
 306 XXX
 307
 308 =back
 309
 310 =head1 Configuration and Compilation
 311
 312 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 313 go here.  Any other changes to the Perl build process should be listed here.
 314 However, any platform-specific changes should be listed in the
 315 L</Platform Support> section, instead.
 316
 317 [ List changes as a =item entry ].
 318
 319 =over 4
 320
 321 =item *
 322
 323 XXX
 324
 325 =back
 326
 327 =head1 Testing
 328
 329 XXX Any significant changes to the testing of a freshly built perl should be
 330 listed here.  Changes which create B<new> files in F<t/> go here as do any
 331 large changes to the testing harness (e.g. when parallel testing was added).
 332 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 333 that they represent may be covered elsewhere.
 334
 335 [ List each test improvement as a =item entry ]
 336
 337 =over 4
 338
 339 =item *
 340
 341 XXX
 342
 343 =back
 344
 345 =head1 Platform Support
 346
 347 XXX Any changes to platform support should be listed in the sections below.
 348
 349 [ Within the sections, list each platform as a =item entry with specific
 350 changes as paragraphs below it. ]
 351
 352 =head2 New Platforms
 353
 354 XXX List any platforms that this version of perl compiles on, that previous
 355 versions did not.  These will either be enabled by new files in the F<hints/>
 356 directories, or new subdirectories and F<README> files at the top level of the
 357 source tree.
 358
 359 =over 4
 360
 361 =item XXX-some-platform
 362
 363 XXX
 364
 365 =back
 366
 367 =head2 Discontinued Platforms
 368
 369 XXX List any platforms that this version of perl no longer compiles on.
 370
 371 =over 4
 372
 373 =item XXX-some-platform
 374
 375 XXX
 376
 377 =back
 378
 379 =head2 Platform-Specific Notes
 380
 381 XXX List any changes for specific platforms.  This could include configuration
 382 and compilation changes or changes in portability/compatibility.  However,
 383 changes within modules for platforms should generally be listed in the
 384 L</Modules and Pragmata> section.
 385
 386 =over 4
 387
 388 =item XXX-some-platform
 389
 390 XXX
 391
 392 =back
 393
 394 =head1 Internal Changes
 395
 396 XXX Changes which affect the interface available to C<XS> code go here.  Other
 397 significant internal changes for future core maintainers should be noted as
 398 well.
 399
 400 [ List each change as a =item entry ]
 401
 402 =over 4
 403
 404 =item *
 405
 406 New versions of macros like C<isALPHA_utf8> and C<toLOWER_utf8>  have
 407 been added, each with the
 408 suffix C<_safe>, like C<isSPACE_utf8_safe>.  These take an extra
 409 parameter, giving an upper limit of how far into the string it is safe
 410 to read.  Using the old versions could cause attempts to read beyond the
 411 end of the input buffer if the UTF-8 is not well-formed, and ther use
 412 now raises a deprecation warning.  Details are at
 413 L<perlapi/Character classification>.
 414
 415 =item *
 416
 417 Calling macros like C<isALPHA_utf8> on malformed UTF-8 have issued a
 418 deprecation warning since Perl v5.18.  They now die.
 419 Similarly, macros like C<toLOWER_utf8> on malformed UTF-8 now die.
 420
 421 =item *
 422
 423 Calling the functions C<utf8n_to_uvchr> and its derivatives, while
 424 passing a string length of 0 is now asserted against in DEBUGGING
 425 builds, and otherwise returns the Unicode REPLACEMENT CHARACTER.   If
 426 you have nothing to decode, you shouldn't call the decode function.
 427
 428 =item *
 429
 430 The functions C<utf8n_to_uvchr> and its derivatives now return the
 431 Unicode REPLACEMENT CHARACTER if called with UTF-8 that has the overlong
 432 malformation, and that malformation is allowed by the input parameters.
 433 This malformation is where the UTF-8 looks valid syntactically, but
 434 there is a shorter sequence that yields the same code point.  This has
 435 been forbidden since Unicode version 3.1.
 436
 437 =item *
 438
 439 The functions C<utf8n_to_uvchr> and its derivatives now accept an input
 440 flag to allow the overflow malformation.  This malformation is when the
 441 UTF-8 may be syntactically valid, but the code point it represents is
 442 not capable of being represented in the word length on the platform.
 443 What "allowed" means in this case is that the function doesn't return an
 444 error, and advances the parse pointer to beyond the UTF-8 in question,
 445 but it returns the Unicode REPLACEMENT CHARACTER as the value of the
 446 code point (since the real value is not representable).
 447
 448 =back
 449
 450 =head1 Selected Bug Fixes
 451
 452 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 453 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 454
 455 [ List each fix as a =item entry ]
 456
 457 =over 4
 458
 459 =item *
 460
 461 Under C<use utf8>, the entire Perl program is now checked that the UTF-8
 462 is wellformed.  This resolves [perl #126310].
 463
 464 =back
 465
 466 =head1 Known Problems
 467
 468 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 469 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 470 platform specific bugs also go here.
 471
 472 [ List each fix as a =item entry ]
 473
 474 =over 4
 475
 476 =item *
 477
 478 XXX
 479
 480 =back
 481
 482 =head1 Errata From Previous Releases
 483
 484 =over 4
 485
 486 =item *
 487
 488 XXX Add anything here that we forgot to add, or were mistaken about, in
 489 the perldelta of a previous release.
 490
 491 =back
 492
 493 =head1 Obituary
 494
 495 XXX If any significant core contributor has died, we've added a short obituary
 496 here.
 497
 498 =head1 Acknowledgements
 499
 500 XXX Generate this with:
 501
 502   perl Porting/acknowledgements.pl v5.25.5..HEAD
 503
 504 =head1 Reporting Bugs
 505
 506 If you find what you think is a bug, you might check the perl bug database
 507 at L<https://rt.perl.org/> .  There may also be information at
 508 L<http://www.perl.org/> , the Perl Home Page.
 509
 510 If you believe you have an unreported bug, please run the L<perlbug> program
 511 included with your release.  Be sure to trim your bug down to a tiny but
 512 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 513 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 514
 515 If the bug you are reporting has security implications which make it
 516 inappropriate to send to a publicly archived mailing list, then see
 517 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
 518 for details of how to report the issue.
 519
 520 =head1 SEE ALSO
 521
 522 The F<Changes> file for an explanation of how to view exhaustive details on
 523 what changed.
 524
 525 The F<INSTALL> file for how to build Perl.
 526
 527 The F<README> file for general stuff.
 528
 529 The F<Artistic> and F<Copying> files for copyright information.
 530
 531 =cut