This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta: Rmv git relict line
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
c1e74734
CBW
5[ this is a template for a new perldelta file. Any text flagged as
6XXX needs to be processed before release. ]
ad32999b 7
c1e74734 8perldelta - what is new for perl v5.15.8
88c5c971 9
c1e74734 10=head1 DESCRIPTION
8f12b018 11
c1e74734
CBW
12This document describes differences between the 5.15.7 release and
13the 5.15.8 release.
8f12b018 14
c1e74734
CBW
15If you are upgrading from an earlier release such as 5.15.6, first read
16L<perl5157delta>, which describes differences between 5.15.6 and
175.15.7.
26afcec5 18
c1e74734 19=head1 Notice
8f12b018 20
c1e74734 21XXX Any important notices here
d7fbd56d 22
c1e74734 23=head1 Core Enhancements
d7fbd56d 24
c1e74734
CBW
25XXX New core language features go here. Summarise user-visible core language
26enhancements. Particularly prominent performance optimisations could go
27here, but most should go in the L</Performance Enhancements> section.
d7fbd56d 28
c1e74734 29[ List each enhancement as a =head2 entry ]
711a3903 30
66cbab2c
KW
31=head2 Improved ability to mix locales and Unicode, including UTF-8 locales
32
33An optional parameter has been added to C<use locale>
34
35 use locale ':not_characters';
36
37which tells Perl to use all but the C<LC_CTYPE> and C<LC_COLLATE>
38portions of the current locale. Instead, the character set is assumed
39to be Unicode. This allows locales and Unicode to be seamlessly mixed,
40including the increasingly frequent UTF-8 locales. When using this
41hybrid form of locales, the C<:locale> layer to the L<open> pragma can
42be used to interface with the file system, and there are CPAN modules
43available for ARGV and environment variable conversions.
44
45Full details are in L<perllocale>.
46
c1e74734 47=head1 Security
711a3903 48
c1e74734
CBW
49XXX Any security-related notices go here. In particular, any security
50vulnerabilities closed should be noted here rather than in the
51L</Selected Bug Fixes> section.
711a3903 52
c1e74734 53[ List each security issue as a =head2 entry ]
6ba817f3 54
c1e74734 55=head1 Incompatible Changes
6ba817f3 56
c1e74734 57XXX For a release on a stable branch, this section aspires to be:
6b339779 58
c1e74734
CBW
59 There are no changes intentionally incompatible with 5.XXX.XXX
60 If any exist, they are bugs, and we request that you submit a
61 report. See L</Reporting Bugs> below.
6b339779 62
c1e74734 63[ List each incompatible change as a =head2 entry ]
b240fc0f 64
c1e74734 65=head1 Deprecations
b240fc0f 66
c1e74734
CBW
67XXX Any deprecated features, syntax, modules etc. should be listed here.
68In particular, deprecated modules should be listed here even if they are
69listed as an updated module in the L</Modules and Pragmata> section.
4e6ab4ad 70
c1e74734 71[ List each deprecation as a =head2 entry ]
4e6ab4ad 72
c1e74734 73=head1 Performance Enhancements
79e10968 74
c1e74734
CBW
75XXX Changes which enhance performance without changing behaviour go here. There
76may well be none in a stable release.
79e10968 77
c1e74734 78[ List each enhancement as a =item entry ]
ea88c40c 79
c1e74734 80=over 4
9d055b1a
CBW
81
82=item *
83
c1e74734 84XXX
cadced9f 85
c1e74734 86=back
cadced9f 87
c1e74734 88=head1 Modules and Pragmata
cadced9f 89
c1e74734
CBW
90XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
91go here. If Module::CoreList is updated, generate an initial draft of the
92following sections using F<Porting/corelist-perldelta.pl>, which prints stub
93entries to STDOUT. Results can be pasted in place of the '=head2' entries
94below. A paragraph summary for important changes should then be added by hand.
95In an ideal world, dual-life modules would have a F<Changes> file that could be
96cribbed.
cadced9f 97
c1e74734 98[ Within each section, list entries as a =item entry ]
07feb684 99
c1e74734 100=head2 New Modules and Pragmata
cadced9f 101
c1e74734 102=over 4
632c5d30
NC
103
104=item *
105
c1e74734 106XXX
4e6e9b23 107
c1e74734 108=back
4e6e9b23 109
c1e74734 110=head2 Updated Modules and Pragmata
4e6e9b23 111
c1e74734 112=over 4
1887da8c
RS
113
114=item *
115
462f46e7 116L<Pod::Parser> has been upgraded from version 1.37 to version 1.50.
88c5c971 117
c1e74734 118=back
c0504019 119
c1e74734 120=head2 Removed Modules and Pragmata
937a45d0 121
c1e74734 122=over 4
937a45d0 123
ef337e16
CBW
124=item *
125
c1e74734 126XXX
ef337e16 127
7f28d7ed 128=back
679b54e7 129
52deee2e 130=head1 Documentation
3c7c5233 131
c1e74734
CBW
132XXX Changes to files in F<pod/> go here. Consider grouping entries by
133file and be sure to link to the appropriate page, e.g. L<perlfunc>.
a71d67b1 134
c1e74734 135=head2 New Documentation
cadced9f 136
c1e74734 137XXX Changes which create B<new> files in F<pod/> go here.
cadced9f 138
c1e74734 139=head3 L<XXX>
cadced9f 140
c1e74734 141XXX Description of the purpose of the new file here
cadced9f 142
c1e74734 143=head2 Changes to Existing Documentation
cadced9f 144
c1e74734
CBW
145XXX Changes which significantly change existing files in F<pod/> go here.
146However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
147section.
cadced9f 148
c1e74734 149=head3 L<XXX>
7e7629fa 150
52deee2e 151=over 4
7e7629fa
FC
152
153=item *
154
c1e74734 155XXX Description of the change here
c2654555 156
52deee2e 157=back
85ca3be7 158
52deee2e 159=head1 Diagnostics
85ca3be7 160
52deee2e
DR
161The following additions or changes have been made to diagnostic output,
162including warnings and fatal error messages. For the complete list of
163diagnostic messages, see L<perldiag>.
7788a270 164
c1e74734
CBW
165XXX New or changed warnings emitted by the core's C<C> code go here. Also
166include any changes in L<perldiag> that reconcile it to the C<C> code.
6138a722 167
c1e74734
CBW
168[ Within each section, list entries as a =item entry that links to perldiag,
169 e.g.
a47fb3fe 170
c1e74734 171 =item *
4888c563 172
c1e74734
CBW
173 L<Invalid version object|perldiag/"Invalid version object">
174]
a3f52e2e 175
c1e74734 176=head2 New Diagnostics
52272450 177
c1e74734 178XXX Newly added diagnostic messages go here
52272450 179
c1e74734 180=head3 New Errors
a47fb3fe 181
0aaeb177 182=over 4
7ef25837 183
6d110ad0
FC
184=item *
185
c1e74734 186XXX L<message|perldiag/"message">
604a99bd 187
c1e74734 188=back
ea88c40c 189
c1e74734 190=head3 New Warnings
ea88c40c 191
c1e74734 192=over 4
ea88c40c
FC
193
194=item *
195
c1e74734 196XXX L<message|perldiag/"message">
ea88c40c 197
6d110ad0
FC
198=back
199
c1e74734
CBW
200=head2 Changes to Existing Diagnostics
201
202XXX Changes (i.e. rewording) of diagnostic messages go here
cadced9f
FC
203
204=over 4
205
206=item *
207
c1e74734 208XXX Describe change here
cadced9f
FC
209
210=back
211
0aaeb177 212=head1 Utility Changes
9cfd094e 213
c1e74734
CBW
214XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
215here. Most of these are built within the directories F<utils> and F<x2p>.
d7fbd56d 216
c1e74734
CBW
217[ List utility changes as a =head3 entry for each utility and =item
218entries for each change
219Use L<XXX> with program names to get proper documentation linking. ]
d7fbd56d 220
c1e74734 221=head3 L<XXX>
d7fbd56d 222
c1e74734 223=over 4
ba91b4f3 224
b18aa002
FC
225=item *
226
c1e74734 227XXX
b18aa002 228
52deee2e 229=back
ba91b4f3 230
52deee2e 231=head1 Configuration and Compilation
f4912a50 232
c1e74734
CBW
233XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
234go here. Any other changes to the Perl build process should be listed here.
235However, any platform-specific changes should be listed in the
236L</Platform Support> section, instead.
a3f52e2e 237
c1e74734 238[ List changes as a =item entry ].
a3f52e2e 239
0aaeb177 240=over 4
ad32999b 241
f4912a50 242=item *
ad32999b 243
c1e74734 244XXX
c15f899f 245
7f28d7ed 246=back
ad32999b 247
c1e74734 248=head1 Testing
39de7394 249
c1e74734
CBW
250XXX Any significant changes to the testing of a freshly built perl should be
251listed here. Changes which create B<new> files in F<t/> go here as do any
252large changes to the testing harness (e.g. when parallel testing was added).
253Changes to existing files in F<t/> aren't worth summarising, although the bugs
254that they represent may be covered elsewhere.
39de7394 255
c1e74734 256[ List each test improvement as a =item entry ]
39de7394 257
c1e74734 258=over 4
5dd80d85 259
52272450
FC
260=item *
261
c1e74734 262XXX
52272450 263
52deee2e 264=back
5dd80d85 265
c1e74734 266=head1 Platform Support
52272450 267
c1e74734 268XXX Any changes to platform support should be listed in the sections below.
52272450 269
c1e74734
CBW
270[ Within the sections, list each platform as a =item entry with specific
271changes as paragraphs below it. ]
ad266194 272
c1e74734 273=head2 New Platforms
ad266194 274
c1e74734
CBW
275XXX List any platforms that this version of perl compiles on, that previous
276versions did not. These will either be enabled by new files in the F<hints/>
277directories, or new subdirectories and F<README> files at the top level of the
278source tree.
ad266194 279
c1e74734 280=over 4
838cf719 281
c1e74734 282=item XXX-some-platform
838cf719 283
c1e74734 284XXX
b00f6edb 285
c1e74734 286=back
b00f6edb 287
c1e74734 288=head2 Discontinued Platforms
7a3fd9ed 289
c1e74734 290XXX List any platforms that this version of perl no longer compiles on.
7a3fd9ed 291
c1e74734 292=over 4
1a50d74b 293
c1e74734 294=item XXX-some-platform
1a50d74b 295
c1e74734 296XXX
ea88c40c 297
c1e74734 298=back
ea88c40c 299
c1e74734 300=head2 Platform-Specific Notes
ea88c40c 301
c1e74734
CBW
302XXX List any changes for specific platforms. This could include configuration
303and compilation changes or changes in portability/compatibility. However,
304changes within modules for platforms should generally be listed in the
305L</Modules and Pragmata> section.
ea88c40c 306
c1e74734 307=over 4
ea88c40c 308
c1e74734 309=item XXX-some-platform
ea88c40c 310
c1e74734 311XXX
ea88c40c 312
c1e74734 313=back
ea88c40c 314
c1e74734 315=head1 Internal Changes
ea88c40c 316
c1e74734
CBW
317XXX Changes which affect the interface available to C<XS> code go here.
318Other significant internal changes for future core maintainers should
319be noted as well.
ea88c40c 320
c1e74734 321[ List each change as a =item entry ]
ea88c40c 322
c1e74734 323=over 4
ea88c40c
FC
324
325=item *
326
c1e74734 327XXX
ea88c40c 328
c1e74734 329=back
ea88c40c 330
c1e74734 331=head1 Selected Bug Fixes
ea88c40c 332
c1e74734
CBW
333XXX Important bug fixes in the core language are summarised here.
334Bug fixes in files in F<ext/> and F<lib/> are best summarised in
335L</Modules and Pragmata>.
ea88c40c 336
c1e74734 337[ List each fix as a =item entry ]
ea88c40c 338
c1e74734 339=over 4
ea88c40c
FC
340
341=item *
342
c1e74734 343XXX
ea88c40c
FC
344
345=back
346
c1e74734 347=head1 Known Problems
ea88c40c 348
c1e74734
CBW
349XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
350tests that had to be C<TODO>ed for the release would be noted here, unless
351they were specific to a particular platform (see below).
ea88c40c 352
c1e74734
CBW
353This is a list of some significant unfixed bugs, which are regressions
354from either 5.XXX.XXX or 5.XXX.XXX.
ea88c40c 355
c1e74734 356[ List each fix as a =item entry ]
ea88c40c 357
c1e74734 358=over 4
18af289e 359
c1e74734 360=item *
18af289e 361
c1e74734 362XXX
1ac442bc 363
c1e74734 364=back
c0154fe2 365
c1e74734 366=head1 Obituary
1ac442bc 367
c1e74734
CBW
368XXX If any significant core contributor has died, we've added a short obituary
369here.
84b2a83e 370
52deee2e 371=head1 Acknowledgements
8fe05716 372
c1e74734
CBW
373XXX Generate this with:
374
375 perl Porting/acknowledgements.pl v5.15.7..HEAD
29cf780c 376
44691e6f
AB
377=head1 Reporting Bugs
378
379If you find what you think is a bug, you might check the articles
52deee2e
DR
380recently posted to the comp.lang.perl.misc newsgroup and the perl
381bug database at http://rt.perl.org/perlbug/ . There may also be
44691e6f
AB
382information at http://www.perl.org/ , the Perl Home Page.
383
384If you believe you have an unreported bug, please run the L<perlbug>
52deee2e
DR
385program included with your release. Be sure to trim your bug down
386to a tiny but sufficient test case. Your bug report, along with the
387output of C<perl -V>, will be sent off to perlbug@perl.org to be
388analysed by the Perl porting team.
44691e6f
AB
389
390If the bug you are reporting has security implications, which make it
52deee2e
DR
391inappropriate to send to a publicly archived mailing list, then please send
392it to perl5-security-report@perl.org. This points to a closed subscription
393unarchived mailing list, which includes
394all the core committers, who will be able
395to help assess the impact of issues, figure out a resolution, and help
396co-ordinate the release of patches to mitigate or fix the problem across all
397platforms on which Perl is supported. Please only use this address for
398security issues in the Perl core, not for modules independently
399distributed on CPAN.
44691e6f
AB
400
401=head1 SEE ALSO
402
52deee2e
DR
403The F<Changes> file for an explanation of how to view exhaustive details
404on what changed.
44691e6f
AB
405
406The F<INSTALL> file for how to build Perl.
407
408The F<README> file for general stuff.
409
410The F<Artistic> and F<Copying> files for copyright information.
411
412=cut