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