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
   6 XXX needs to be processed before release. ]
   7
   8 perldelta - what is new for perl v5.15.4
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.15.3 release and
  13 the 5.15.4 release.
  14
  15 If you are upgrading from an earlier release such as 5.15.3, first read
  16 L<perl5153delta>, which describes differences between 5.15.3 and
  17 5.15.4.
  18
  19 =head1 Notice
  20
  21 XXX Any important notices here
  22
  23 =head1 Core Enhancements
  24
  25 =head2 $^X converted to an absolute path on FreeBSD, OS X and Solaris
  26
  27 C<$^X> is now converted to an absolute path on OS X, FreeBSD (without
  28 needing F</proc> mounted) and Solaris 10 and 11. This augments the
  29 previous approach of using F</proc> on Linux, FreeBSD and NetBSD
  30 (in all cases, where mounted).
  31
  32 This makes relocatable perl installations more useful on these platforms.
  33 (See "Relocatable @INC" in F<INSTALL>)
  34
  35 =head1 Security
  36
  37 XXX Any security-related notices go here.  In particular, any security
  38 vulnerabilities closed should be noted here rather than in the
  39 L</Selected Bug Fixes> section.
  40
  41 [ List each security issue as a =head2 entry ]
  42
  43 =head1 Incompatible Changes
  44
  45 XXX For a release on a stable branch, this section aspires to be:
  46
  47     There are no changes intentionally incompatible with 5.XXX.XXX
  48     If any exist, they are bugs and reports are welcome.
  49
  50 [ List each incompatible change as a =head2 entry ]
  51
  52 =head1 Deprecations
  53
  54 XXX Any deprecated features, syntax, modules etc. should be listed here.
  55 In particular, deprecated modules should be listed here even if they are
  56 listed as an updated module in the L</Modules and Pragmata> section.
  57
  58 [ List each deprecation as a =head2 entry ]
  59
  60 =head1 Performance Enhancements
  61
  62 XXX Changes which enhance performance without changing behaviour go here. There
  63 may well be none in a stable release.
  64
  65 [ List each enhancement as a =item entry ]
  66
  67 =over 4
  68
  69 =item *
  70
  71 XXX
  72
  73 =back
  74
  75 =head1 Modules and Pragmata
  76
  77 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
  78 go here.  If Module::CoreList is updated, generate an initial draft of the
  79 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
  80 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
  81 below.  A paragraph summary for important changes should then be added by hand.
  82 In an ideal world, dual-life modules would have a F<Changes> file that could be
  83 cribbed.
  84
  85 [ Within each section, list entries as a =item entry ]
  86
  87 =head2 New Modules and Pragmata
  88
  89 =over 4
  90
  91 =item *
  92
  93 XXX
  94
  95 =back
  96
  97 =head2 Updated Modules and Pragmata
  98
  99 =over 4
 100
 101 =item *
 102
 103 L<perlfaq> has been upgraded from version 5.0150034 to version 5.0150035.
 104
 105 =back
 106
 107 =head2 Removed Modules and Pragmata
 108
 109 =over 4
 110
 111 =item *
 112
 113 XXX
 114
 115 =back
 116
 117 =head1 Documentation
 118
 119 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
 120 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
 121
 122 =head2 New Documentation
 123
 124 XXX Changes which create B<new> files in F<pod/> go here.
 125
 126 =head3 L<XXX>
 127
 128 XXX Description of the purpose of the new file here
 129
 130 =head2 Changes to Existing Documentation
 131
 132 XXX Changes which significantly change existing files in F<pod/> go here.
 133 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
 134 section.
 135
 136 =head3 L<XXX>
 137
 138 =over 4
 139
 140 =item *
 141
 142 XXX Description of the change here
 143
 144 =back
 145
 146 =head1 Diagnostics
 147
 148 The following additions or changes have been made to diagnostic output,
 149 including warnings and fatal error messages.  For the complete list of
 150 diagnostic messages, see L<perldiag>.
 151
 152 XXX New or changed warnings emitted by the core's C<C> code go here. Also
 153 include any changes in L<perldiag> that reconcile it to the C<C> code.
 154
 155 [ Within each section, list entries as a =item entry that links to perldiag,
 156   e.g.
 157
 158   =item *
 159
 160   L<Invalid version object|perldiag/"Invalid version object">
 161 ]
 162
 163 =head2 New Diagnostics
 164
 165 XXX Newly added diagnostic messages go here
 166
 167 =head3 New Errors
 168
 169 =over 4
 170
 171 =item *
 172
 173 XXX L<message|perldiag/"message">
 174
 175 =back
 176
 177 =head3 New Warnings
 178
 179 =over 4
 180
 181 =item *
 182
 183 XXX L<message|perldiag/"message">
 184
 185 =back
 186
 187 =head2 Changes to Existing Diagnostics
 188
 189 XXX Changes (i.e. rewording) of diagnostic messages go here
 190
 191 =over 4
 192
 193 =item *
 194
 195 XXX Describe change here
 196
 197 =back
 198
 199 =head1 Utility Changes
 200
 201 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
 202 here. Most of these are built within the directories F<utils> and F<x2p>.
 203
 204 [ List utility changes as a =head3 entry for each utility and =item
 205 entries for each change
 206 Use L<XXX> with program names to get proper documentation linking. ]
 207
 208 =head3 L<XXX>
 209
 210 =over 4
 211
 212 =item *
 213
 214 XXX
 215
 216 =back
 217
 218 =head1 Configuration and Compilation
 219
 220 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 221 go here.  Any other changes to the Perl build process should be listed here.
 222 However, any platform-specific changes should be listed in the
 223 L</Platform Support> section, instead.
 224
 225 [ List changes as a =item entry ].
 226
 227 =over 4
 228
 229 =item *
 230
 231 XXX
 232
 233 =back
 234
 235 =head1 Testing
 236
 237 XXX Any significant changes to the testing of a freshly built perl should be
 238 listed here.  Changes which create B<new> files in F<t/> go here as do any
 239 large changes to the testing harness (e.g. when parallel testing was added).
 240 Changes to existing files in F<t/> aren't worth summarising, although the bugs
 241 that they represent may be covered elsewhere.
 242
 243 [ List each test improvement as a =item entry ]
 244
 245 =over 4
 246
 247 =item *
 248
 249 F<t/porting/checkcfgvar.t> now tests that all config.sh-style files are
 250 complete. These are used by the various non-*nix to generate their
 251 F<config.h>, and an incomplete input file will generate invalid output.
 252
 253 =back
 254
 255 =head1 Platform Support
 256
 257 XXX Any changes to platform support should be listed in the sections below.
 258
 259 [ Within the sections, list each platform as a =item entry with specific
 260 changes as paragraphs below it. ]
 261
 262 =head2 New Platforms
 263
 264 XXX List any platforms that this version of perl compiles on, that previous
 265 versions did not. These will either be enabled by new files in the F<hints/>
 266 directories, or new subdirectories and F<README> files at the top level of the
 267 source tree.
 268
 269 =over 4
 270
 271 =item XXX-some-platform
 272
 273 XXX
 274
 275 =back
 276
 277 =head2 Discontinued Platforms
 278
 279 XXX List any platforms that this version of perl no longer compiles on.
 280
 281 =over 4
 282
 283 =item XXX-some-platform
 284
 285 XXX
 286
 287 =back
 288
 289 =head2 Platform-Specific Notes
 290
 291 XXX List any changes for specific platforms. This could include configuration
 292 and compilation changes or changes in portability/compatibility.  However,
 293 changes within modules for platforms should generally be listed in the
 294 L</Modules and Pragmata> section.
 295
 296 =over 4
 297
 298 =item XXX-some-platform
 299
 300 XXX
 301
 302 =back
 303
 304 =head1 Internal Changes
 305
 306 XXX Changes which affect the interface available to C<XS> code go here.
 307 Other significant internal changes for future core maintainers should
 308 be noted as well.
 309
 310 [ List each change as a =item entry ]
 311
 312 =over 4
 313
 314 =item *
 315
 316 XXX
 317
 318 =back
 319
 320 =head1 Selected Bug Fixes
 321
 322 XXX Important bug fixes in the core language are summarised here.
 323 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
 324 L</Modules and Pragmata>.
 325
 326 [ List each fix as a =item entry ]
 327
 328 =over 4
 329
 330 =item *
 331
 332 XXX
 333
 334 =back
 335
 336 =head1 Known Problems
 337
 338 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
 339 tests that had to be C<TODO>ed for the release would be noted here, unless
 340 they were specific to a particular platform (see below).
 341
 342 This is a list of some significant unfixed bugs, which are regressions
 343 from either 5.XXX.XXX or 5.XXX.XXX.
 344
 345 [ List each fix as a =item entry ]
 346
 347 =over 4
 348
 349 =item *
 350
 351 XXX
 352
 353 =back
 354
 355 =head1 Obituary
 356
 357 XXX If any significant core contributor has died, we've added a short obituary
 358 here.
 359
 360 =head1 Acknowledgements
 361
 362 XXX Generate this with:
 363
 364   perl Porting/acknowledgements.pl v5.15.3..HEAD
 365
 366 =head1 Reporting Bugs
 367
 368 If you find what you think is a bug, you might check the articles
 369 recently posted to the comp.lang.perl.misc newsgroup and the perl
 370 bug database at http://rt.perl.org/perlbug/ .  There may also be
 371 information at http://www.perl.org/ , the Perl Home Page.
 372
 373 If you believe you have an unreported bug, please run the L<perlbug>
 374 program included with your release.  Be sure to trim your bug down
 375 to a tiny but sufficient test case.  Your bug report, along with the
 376 output of C<perl -V>, will be sent off to perlbug@perl.org to be
 377 analysed by the Perl porting team.
 378
 379 If the bug you are reporting has security implications, which make it
 380 inappropriate to send to a publicly archived mailing list, then please send
 381 it to perl5-security-report@perl.org. This points to a closed subscription
 382 unarchived mailing list, which includes
 383 all the core committers, who will be able
 384 to help assess the impact of issues, figure out a resolution, and help
 385 co-ordinate the release of patches to mitigate or fix the problem across all
 386 platforms on which Perl is supported. Please only use this address for
 387 security issues in the Perl core, not for modules independently
 388 distributed on CPAN.
 389
 390 =head1 SEE ALSO
 391
 392 The F<Changes> file for an explanation of how to view exhaustive details
 393 on what changed.
 394
 395 The F<INSTALL> file for how to build Perl.
 396
 397 The F<README> file for general stuff.
 398
 399 The F<Artistic> and F<Copying> files for copyright information.
 400
 401 =cut