Porting/perl5200delta.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.20.0
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.18.0 release and the
  13 5.20.0 release.
  14
  15 If you are upgrading from an earlier release such as 5.16.0, first read
  16 L<perl5180delta>, which describes differences between 5.16.0 and 5.18.0.
  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 XXX Note that deprecated modules should be listed here even if they are listed
  73 as an updated module in the L</Modules and Pragmata> section.
  74
  75 =back
  76
  77 [ List each other deprecation as a =head2 entry ]
  78
  79 =head1 Performance Enhancements
  80
  81 XXX Changes which enhance performance without changing behaviour go here.
  82 There may well be none in a stable release.
  83
  84 [ List each enhancement as a =item entry ]
  85
  86 =over 4
  87
  88 =item *
  89
  90 XXX
  91
  92 =back
  93
  94 =head1 Modules and Pragmata
  95
  96 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
  97 go here.  If Module::CoreList is updated, generate an initial draft of the
  98 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
  99 for important changes should then be added by hand.  In an ideal world,
 100 dual-life modules would have a F<Changes> file that could be cribbed.
 101
 102 [ Within each section, list entries as a =item entry ]
 103
 104 =head2 New Modules and Pragmata
 105
 106 =over 4
 107
 108 =item *
 109
 110 XXX
 111
 112 =back
 113
 114 =head2 Updated Modules and Pragmata
 115
 116 =over 4
 117
 118 =item *
 119
 120 L<XXX> has been upgraded from version A.xx to B.yy.
 121
 122 =back
 123
 124 =head2 Removed Modules and Pragmata
 125
 126 =over 4
 127
 128 =item *
 129
 130 XXX
 131
 132 =back
 133
 134 =head1 Documentation
 135
 136 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 137 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 138
 139 =head2 New Documentation
 140
 141 XXX Changes which create B<new> files in F<pod/> go here.
 142
 143 =head3 L<XXX>
 144
 145 XXX Description of the purpose of the new file here
 146
 147 =head2 Changes to Existing Documentation
 148
 149 XXX Changes which significantly change existing files in F<pod/> go here.
 150 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 151 section.
 152
 153 =head3 L<XXX>
 154
 155 =over 4
 156
 157 =item *
 158
 159 XXX Description of the change here
 160
 161 =back
 162
 163 =head1 Diagnostics
 164
 165 The following additions or changes have been made to diagnostic output,
 166 including warnings and fatal error messages.  For the complete list of
 167 diagnostic messages, see L<perldiag>.
 168
 169 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
 170 include any changes in L<perldiag> that reconcile it to the C<C> code.
 171
 172 =head2 New Diagnostics
 173
 174 XXX Newly added diagnostic messages go under here, separated into New Errors
 175 and New Warnings
 176
 177 =head3 New Errors
 178
 179 =over 4
 180
 181 =item *
 182
 183 XXX L<message|perldiag/"message">
 184
 185 =back
 186
 187 =head3 New Warnings
 188
 189 =over 4
 190
 191 =item *
 192
 193 XXX L<message|perldiag/"message">
 194
 195 =back
 196
 197 =head2 Changes to Existing Diagnostics
 198
 199 XXX Changes (i.e. rewording) of diagnostic messages go here
 200
 201 =over 4
 202
 203 =item *
 204
 205 XXX Describe change here
 206
 207 =back
 208
 209 =head1 Utility Changes
 210
 211 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
 212 Most of these are built within the directories F<utils> and F<x2p>.
 213
 214 [ List utility changes as a =head3 entry for each utility and =item
 215 entries for each change
 216 Use L<XXX> with program names to get proper documentation linking. ]
 217
 218 =head3 L<XXX>
 219
 220 =over 4
 221
 222 =item *
 223
 224 XXX
 225
 226 =back
 227
 228 =head1 Configuration and Compilation
 229
 230 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 231 go here.  Any other changes to the Perl build process should be listed here.
 232 However, any platform-specific changes should be listed in the
 233 L</Platform Support> section, instead.
 234
 235 [ List changes as a =item entry ].
 236
 237 =over 4
 238
 239 =item *
 240
 241 XXX
 242
 243 =back
 244
 245 =head1 Testing
 246
 247 XXX Any significant changes to the testing of a freshly built perl should be
 248 listed here.  Changes which create B<new> files in F<t/> go here as do any
 249 large changes to the testing harness (e.g. when parallel testing was added).
 250 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
 251 that they represent may be covered elsewhere.
 252
 253 [ List each test improvement as a =item entry ]
 254
 255 =over 4
 256
 257 =item *
 258
 259 XXX
 260
 261 =back
 262
 263 =head1 Platform Support
 264
 265 XXX Any changes to platform support should be listed in the sections below.
 266
 267 [ Within the sections, list each platform as a =item entry with specific
 268 changes as paragraphs below it. ]
 269
 270 =head2 New Platforms
 271
 272 XXX List any platforms that this version of perl compiles on, that previous
 273 versions did not.  These will either be enabled by new files in the F<hints/>
 274 directories, or new subdirectories and F<README> files at the top level of the
 275 source tree.
 276
 277 =over 4
 278
 279 =item XXX-some-platform
 280
 281 XXX
 282
 283 =back
 284
 285 =head2 Discontinued Platforms
 286
 287 XXX List any platforms that this version of perl no longer compiles on.
 288
 289 =over 4
 290
 291 =item XXX-some-platform
 292
 293 XXX
 294
 295 =back
 296
 297 =head2 Platform-Specific Notes
 298
 299 XXX List any changes for specific platforms.  This could include configuration
 300 and compilation changes or changes in portability/compatibility.  However,
 301 changes within modules for platforms should generally be listed in the
 302 L</Modules and Pragmata> section.
 303
 304 =over 4
 305
 306 =item XXX-some-platform
 307
 308 XXX
 309
 310 =back
 311
 312 =head1 Internal Changes
 313
 314 XXX Changes which affect the interface available to C<XS> code go here.  Other
 315 significant internal changes for future core maintainers should be noted as
 316 well.
 317
 318 [ List each change as a =item entry ]
 319
 320 =over 4
 321
 322 =item *
 323
 324 XXX
 325
 326 =back
 327
 328 =head1 Selected Bug Fixes
 329
 330 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
 331 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
 332
 333 [ List each fix as a =item entry ]
 334
 335 =over 4
 336
 337 =item *
 338
 339 XXX
 340
 341 =back
 342
 343 =head1 Known Problems
 344
 345 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
 346 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
 347 platform specific bugs also go here.
 348
 349 [ List each fix as a =item entry ]
 350
 351 =over 4
 352
 353 =item *
 354
 355 The following modules are known to have test failures with this version of
 356 Perl.  Patches have been submitted, so there will hopefully be new releases
 357 soon:
 358
 359 XXX Go through this list just before the release of 5.20 and remove any
 360 modules that have been fixed.
 361
 362 =over
 363
 364 =item *
 365
 366 L<Data::Structure::Util> version 0.15
 367
 368 =item *
 369
 370 L<Data::Util> version 0.62
 371
 372 =item *
 373
 374 L<Glib> version 1.301
 375
 376 =item *
 377
 378 L<HTML::StripScripts> version 1.05
 379
 380 =item *
 381
 382 L<LaTeX::Encode> version 0.08
 383
 384 =item
 385
 386 L<Mail::SpamAssassin> version 3.3.2
 387
 388 =item
 389
 390 L<Mouse> version 1.11
 391
 392 =item
 393
 394 L<Tk> version 804.031
 395
 396 =back
 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.19.9..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 http://rt.perl.org/perlbug/ .  There may also be information at
 416 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