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