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.19.3
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.19.2 release and the 5.19.3
  13 release.
  14
  15 If you are upgrading from an earlier release such as 5.19.1, first read
  16 L<perl5192delta>, which describes differences between 5.19.1 and 5.19.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 =head2 B<-F> now implies B<-a> and B<-a> implies B<-n>
  31
  32 Previously B<-F> without B<-a> was a no-op, and B<-a> without B<-n> or
  33 B<-p> was a no-op, with this change, if you supply B<-F> then both
  34 B<-a> and B<-n> are implied and if you supply B<-a> then B<-n> is implied.
  35
  36 You can still use B<-p> for its extra behaviour. [perl #116190]
  37
  38 =head1 Security
  39
  40 XXX Any security-related notices go here.  In particular, any security
  41 vulnerabilities closed should be noted here rather than in the
  42 L</Selected Bug Fixes> section.
  43
  44 [ List each security issue as a =head2 entry ]
  45
  46 =head1 Incompatible Changes
  47
  48 XXX For a release on a stable branch, this section aspires to be:
  49
  50     There are no changes intentionally incompatible with 5.XXX.XXX
  51     If any exist, they are bugs, and we request that you submit a
  52     report.  See L</Reporting Bugs> below.
  53
  54 [ List each incompatible change as a =head2 entry ]
  55
  56 =head1 Deprecations
  57
  58 XXX Any deprecated features, syntax, modules etc. should be listed here.
  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 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>, which prints stub
 107 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
 108 below.  A paragraph summary for important changes should then be added by hand.
 109 In an ideal world, dual-life modules would have a F<Changes> file that could be
 110 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<Data::Dumper> has been upgraded from version 2.147 to 2.148.
 131
 132 The compatbility of the XS implementation with the pure perl version
 133 under C<Useqq> has been improved. [perl #118933]
 134
 135 =item *
 136
 137 L<Storable> has been upgraded from version 2.45 to 2.46.
 138
 139 Avoid creating temporary objects for STORABLE_attach when they aren't
 140 required. [perl #118907]
 141
 142 =item *
 143
 144 L<bignum> has been upgraded from version 0.35 to 0.36.
 145
 146 L<bigrat> wasn't correctly updating an internal variable when C<use>d
 147 with a C<lib> option.
 148
 149 =back
 150
 151 =head2 Removed Modules and Pragmata
 152
 153 =over 4
 154
 155 =item *
 156
 157 XXX
 158
 159 =back
 160
 161 =head1 Documentation
 162
 163 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 164 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 165
 166 =head2 New Documentation
 167
 168 XXX Changes which create B<new> files in F<pod/> go here.
 169
 170 =head3 L<XXX>
 171
 172 XXX Description of the purpose of the new file here
 173
 174 =head2 Changes to Existing Documentation
 175
 176 XXX Changes which significantly change existing files in F<pod/> go here.
 177 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 178 section.
 179
 180 =head3 L<perlopentut>
 181
 182 =over 4
 183
 184 =item *
 185
 186 The C<open> tutorial has been completely rewriten by Tom Christiansen, and now
 187 focuses on covering only the basics, rather than providing a comprehensive
 188 reference to all things openable.  This rewrite came as the result of a
 189 vigorous discussion on perl5-porters kicked off by a set of improvements
 190 written by Alexander Hartmaier to the existing C<perlopentut>.  A "more than
 191 you ever wanted to know about C<open>" document may follow in subsequent
 192 versions of perl.
 193
 194 =back
 195
 196 =head1 Diagnostics
 197
 198 The following additions or changes have been made to diagnostic output,
 199 including warnings and fatal error messages.  For the complete list of
 200 diagnostic messages, see L<perldiag>.
 201
 202 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 203 include any changes in L<perldiag> that reconcile it to the C<C> code.
 204
 205 =head2 New Diagnostics
 206
 207 XXX Newly added diagnostic messages go under here, separated into New Errors
 208 and New Warnings
 209
 210 =head3 New Errors
 211
 212 =over 4
 213
 214 =item *
 215
 216 XXX L<message|perldiag/"message">
 217
 218 =back
 219
 220 =head3 New Warnings
 221
 222 =over 4
 223
 224 =item *
 225
 226 XXX L<message|perldiag/"message">
 227
 228 =back
 229
 230 =head2 Changes to Existing Diagnostics
 231
 232 XXX Changes (i.e. rewording) of diagnostic messages go here
 233
 234 =over 4
 235
 236 =item *
 237
 238 XXX Describe change here
 239
 240 =back
 241
 242 =head1 Utility Changes
 243
 244 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 245 Most of these are built within the directories F<utils> and F<x2p>.
 246
 247 [ List utility changes as a =head3 entry for each utility and =item
 248 entries for each change
 249 Use L<XXX> with program names to get proper documentation linking. ]
 250
 251 =head3 L<XXX>
 252
 253 =over 4
 254
 255 =item *
 256
 257 XXX
 258
 259 =back
 260
 261 =head1 Configuration and Compilation
 262
 263 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 264 go here.  Any other changes to the Perl build process should be listed here.
 265 However, any platform-specific changes should be listed in the
 266 L</Platform Support> section, instead.
 267
 268 [ List changes as a =item entry ].
 269
 270 =over 4
 271
 272 =item *
 273
 274 XXX
 275
 276 =back
 277
 278 =head1 Testing
 279
 280 XXX Any significant changes to the testing of a freshly built perl should be
 281 listed here.  Changes which create B<new> files in F<t/> go here as do any
 282 large changes to the testing harness (e.g. when parallel testing was added).
 283 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 284 that they represent may be covered elsewhere.
 285
 286 [ List each test improvement as a =item entry ]
 287
 288 =over 4
 289
 290 =item *
 291
 292 XXX
 293
 294 =back
 295
 296 =head1 Platform Support
 297
 298 XXX Any changes to platform support should be listed in the sections below.
 299
 300 [ Within the sections, list each platform as a =item entry with specific
 301 changes as paragraphs below it. ]
 302
 303 =head2 New Platforms
 304
 305 XXX List any platforms that this version of perl compiles on, that previous
 306 versions did not.  These will either be enabled by new files in the F<hints/>
 307 directories, or new subdirectories and F<README> files at the top level of the
 308 source tree.
 309
 310 =over 4
 311
 312 =item XXX-some-platform
 313
 314 XXX
 315
 316 =back
 317
 318 =head2 Discontinued Platforms
 319
 320 XXX List any platforms that this version of perl no longer compiles on.
 321
 322 =over 4
 323
 324 =item XXX-some-platform
 325
 326 XXX
 327
 328 =back
 329
 330 =head2 Platform-Specific Notes
 331
 332 XXX List any changes for specific platforms.  This could include configuration
 333 and compilation changes or changes in portability/compatibility.  However,
 334 changes within modules for platforms should generally be listed in the
 335 L</Modules and Pragmata> section.
 336
 337 =over 4
 338
 339 =item XXX-some-platform
 340
 341 XXX
 342
 343 =back
 344
 345 =head1 Internal Changes
 346
 347 XXX Changes which affect the interface available to C<XS> code go here.  Other
 348 significant internal changes for future core maintainers should be noted as
 349 well.
 350
 351 [ List each change as a =item entry ]
 352
 353 =over 4
 354
 355 =item *
 356
 357 XXX
 358
 359 =back
 360
 361 =head1 Selected Bug Fixes
 362
 363 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 364 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 365
 366 [ List each fix as a =item entry ]
 367
 368 =over 4
 369
 370 =item *
 371
 372 XXX
 373
 374 =back
 375
 376 =head1 Known Problems
 377
 378 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 379 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 380 platform specific bugs also go here.
 381
 382 [ List each fix as a =item entry ]
 383
 384 =over 4
 385
 386 =item *
 387
 388 XXX
 389
 390 =back
 391
 392 =head1 Obituary
 393
 394 XXX If any significant core contributor has died, we've added a short obituary
 395 here.
 396
 397 =head1 Acknowledgements
 398
 399 XXX Generate this with:
 400
 401   perl Porting/acknowledgements.pl v5.19.2..HEAD
 402
 403 =head1 Reporting Bugs
 404
 405 If you find what you think is a bug, you might check the articles recently
 406 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
 407 http://rt.perl.org/perlbug/ .  There may also be information at
 408 http://www.perl.org/ , the Perl Home Page.
 409
 410 If you believe you have an unreported bug, please run the L<perlbug> program
 411 included with your release.  Be sure to trim your bug down to a tiny but
 412 sufficient test case.  Your bug report, along with the output of C<perl -V>,
 413 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
 414
 415 If the bug you are reporting has security implications, which make it
 416 inappropriate to send to a publicly archived mailing list, then please send it
 417 to perl5-security-report@perl.org.  This points to a closed subscription
 418 unarchived mailing list, which includes all the core committers, who will be
 419 able to help assess the impact of issues, figure out a resolution, and help
 420 co-ordinate the release of patches to mitigate or fix the problem across all
 421 platforms on which Perl is supported.  Please only use this address for
 422 security issues in the Perl core, not for modules independently distributed on
 423 CPAN.
 424
 425 =head1 SEE ALSO
 426
 427 The F<Changes> file for an explanation of how to view exhaustive details on
 428 what changed.
 429
 430 The F<INSTALL> file for how to build Perl.
 431
 432 The F<README> file for general stuff.
 433
 434 The F<Artistic> and F<Copying> files for copyright information.
 435
 436 =cut