This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
typo fixes for Unicode UCD
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
583aa5c2
RS
5[ this is a template for a new perldelta file. Any text flagged as XXX needs
6to be processed before release. ]
7
8perldelta - what is new for perl v5.19.1
e128ab2c 9
4eabcf70 10=head1 DESCRIPTION
6db9054f 11
583aa5c2 12This document describes differences between the 5.19.0 release and the 5.19.1
e08634c5 13release.
6db9054f 14
e9912eaa 15=head1 Notice
5ed58cbd 16
583aa5c2
RS
17XXX Any important notices here
18
19=head1 Core Enhancements
20
21XXX New core language features go here. Summarize user-visible core language
22enhancements. Particularly prominent performance optimisations could go
23here, but most should go in the L</Performance Enhancements> section.
24
25[ List each enhancement as a =head2 entry ]
26
27=head1 Security
28
29XXX Any security-related notices go here. In particular, any security
30vulnerabilities closed should be noted here rather than in the
31L</Selected Bug Fixes> section.
32
33[ List each security issue as a =head2 entry ]
34
35=head1 Incompatible Changes
36
37XXX For a release on a stable branch, this section aspires to be:
38
39 There are no changes intentionally incompatible with 5.XXX.XXX
40 If any exist, they are bugs, and we request that you submit a
41 report. See L</Reporting Bugs> below.
42
43[ List each incompatible change as a =head2 entry ]
44
45=head1 Deprecations
46
47XXX Any deprecated features, syntax, modules etc. should be listed here.
48
49=head2 Module removals
50
51XXX Remove this section if inapplicable.
52
53The following modules will be removed from the core distribution in a future
54release, and will at that time need to be installed from CPAN. Distributions
55on CPAN which require these modules will need to list them as prerequisites.
56
57The core versions of these modules will now issue C<"deprecated">-category
58warnings to alert you to this fact. To silence these deprecation warnings,
59install the modules in question from CPAN.
60
61Note that these are (with rare exceptions) fine modules that you are encouraged
62to continue to use. Their disinclusion from core primarily hinges on their
63necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
64not usually on concerns over their design.
65
66XXX Note that deprecated modules should be listed here even if they are listed
67as an updated module in the L</Modules and Pragmata> section.
68
69=over
70
71=item *
72
73...
74
75=back
76
77[ List each other deprecation as a =head2 entry ]
78
79=head1 Performance Enhancements
80
81XXX Changes which enhance performance without changing behaviour go here.
82There 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
90XXX
91
92=back
5ed58cbd 93
e9912eaa 94=head1 Modules and Pragmata
5ed58cbd 95
583aa5c2
RS
96XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97go here. If Module::CoreList is updated, generate an initial draft of the
98following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99entries to STDOUT. Results can be pasted in place of the '=head2' entries
100below. A paragraph summary for important changes should then be added by hand.
101In an ideal world, dual-life modules would have a F<Changes> file that could be
102cribbed.
103
104[ Within each section, list entries as a =item entry ]
105
106=head2 New Modules and Pragmata
107
108=over 4
109
110=item *
111
112XXX
113
114=back
115
e9912eaa 116=head2 Updated Modules and Pragmata
5ed58cbd 117
e9912eaa 118=over 4
5ed58cbd 119
e9912eaa 120=item *
5ed58cbd 121
dbd04185
NC
122Test::Harness has been upgraded from version 3.26 to 3.28
123
124Memory usage is dramatically reduced. t/harness now uses about 10% of the
125memory used by 3.26 and earlier.
126
127C<PERL5LIB> is always propagated to a test's C<@INC>, even under C<-T>.
583aa5c2 128
1fdd5e53
KW
129=item *
130
131Unicode::UCD has been upgraded from version 0.51 to 0.52.
132
133A function, L<Unicode::UCD/search_invlist()> is now available to do
134search an inversion list or map for a code point.
135
583aa5c2
RS
136=back
137
138=head2 Removed Modules and Pragmata
139
140=over 4
5ed58cbd 141
e9912eaa 142=item *
5ed58cbd 143
583aa5c2
RS
144XXX
145
146=back
147
148=head1 Documentation
149
150XXX Changes to files in F<pod/> go here. Consider grouping entries by
151file and be sure to link to the appropriate page, e.g. L<perlfunc>.
152
153=head2 New Documentation
154
155XXX Changes which create B<new> files in F<pod/> go here.
156
157=head3 L<XXX>
158
159XXX Description of the purpose of the new file here
160
161=head2 Changes to Existing Documentation
162
163XXX Changes which significantly change existing files in F<pod/> go here.
164However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
165section.
166
167=head3 L<XXX>
168
169=over 4
1993add8 170
e9912eaa 171=item *
ec985017 172
583aa5c2
RS
173XXX Description of the change here
174
175=back
176
177=head1 Diagnostics
178
179The following additions or changes have been made to diagnostic output,
180including warnings and fatal error messages. For the complete list of
181diagnostic messages, see L<perldiag>.
182
183XXX New or changed warnings emitted by the core's C<C> code go here. Also
184include any changes in L<perldiag> that reconcile it to the C<C> code.
185
186=head2 New Diagnostics
187
188XXX Newly added diagnostic messages go under here, separated into New Errors
189and New Warnings
190
191=head3 New Errors
192
193=over 4
71e6aba6
RS
194
195=item *
196
583aa5c2
RS
197XXX L<message|perldiag/"message">
198
199=back
200
201=head3 New Warnings
202
203=over 4
71e6aba6 204
d5f315e8
KW
205=item *
206
583aa5c2 207XXX L<message|perldiag/"message">
d5f315e8 208
337fb649 209=back
2426c394 210
583aa5c2 211=head2 Changes to Existing Diagnostics
e9912eaa 212
583aa5c2 213XXX Changes (i.e. rewording) of diagnostic messages go here
357b01df 214
583aa5c2 215=over 4
357b01df 216
583aa5c2 217=item *
357b01df 218
583aa5c2 219XXX Describe change here
357b01df 220
583aa5c2 221=back
357b01df 222
583aa5c2 223=head1 Utility Changes
357b01df 224
583aa5c2
RS
225XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
226Most of these are built within the directories F<utils> and F<x2p>.
357b01df 227
583aa5c2
RS
228[ List utility changes as a =head3 entry for each utility and =item
229entries for each change
230Use L<XXX> with program names to get proper documentation linking. ]
357b01df 231
583aa5c2 232=head3 L<XXX>
357b01df 233
583aa5c2 234=over 4
357b01df 235
583aa5c2 236=item *
357b01df 237
583aa5c2 238XXX
357b01df 239
583aa5c2
RS
240=back
241
242=head1 Configuration and Compilation
243
244XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
245go here. Any other changes to the Perl build process should be listed here.
246However, any platform-specific changes should be listed in the
247L</Platform Support> section, instead.
248
249[ List changes as a =item entry ].
250
251=over 4
252
253=item *
254
255XXX
357b01df 256
e9912eaa 257=back
357b01df 258
583aa5c2
RS
259=head1 Testing
260
261XXX Any significant changes to the testing of a freshly built perl should be
262listed here. Changes which create B<new> files in F<t/> go here as do any
263large changes to the testing harness (e.g. when parallel testing was added).
264Changes to existing files in F<t/> aren't worth summarizing, although the bugs
265that they represent may be covered elsewhere.
266
267[ List each test improvement as a =item entry ]
268
269=over 4
270
271=item *
272
273XXX
274
275=back
276
277=head1 Platform Support
278
279XXX Any changes to platform support should be listed in the sections below.
280
281[ Within the sections, list each platform as a =item entry with specific
282changes as paragraphs below it. ]
283
284=head2 New Platforms
285
286XXX List any platforms that this version of perl compiles on, that previous
287versions did not. These will either be enabled by new files in the F<hints/>
288directories, or new subdirectories and F<README> files at the top level of the
289source tree.
290
291=over 4
292
293=item XXX-some-platform
294
295XXX
296
297=back
298
299=head2 Discontinued Platforms
300
301XXX List any platforms that this version of perl no longer compiles on.
302
303=over 4
304
305=item XXX-some-platform
357b01df 306
583aa5c2 307XXX
5ed58cbd 308
583aa5c2
RS
309=back
310
311=head2 Platform-Specific Notes
312
313XXX List any changes for specific platforms. This could include configuration
314and compilation changes or changes in portability/compatibility. However,
315changes within modules for platforms should generally be listed in the
316L</Modules and Pragmata> section.
317
318=over 4
319
7df6ffa3 320=item Mixed-endian platforms
583aa5c2 321
7df6ffa3
NC
322The code supporting C<pack> and C<unpack> operations on mixed endian
323platforms has been removed. We believe that Perl has long been unable to
324build on mixed endian architectures (such as PDP-11s), so we don't think
325that this change will affect any platforms which are able to build v5.18.0.
583aa5c2
RS
326
327=back
328
329=head1 Internal Changes
330
331XXX Changes which affect the interface available to C<XS> code go here. Other
332significant internal changes for future core maintainers should be noted as
333well.
334
335[ List each change as a =item entry ]
336
337=over 4
338
339=item *
340
7df6ffa3
NC
341The functions C<my_swap>, C<my_htonl> and C<my_ntohl> have been removed.
342It is unclear why these functions were ever marked as I<A>, part of the
343API. XS code can't call them directly, as it can't rely on them being
344compiled. Unsurprisingly, no code on CPAN references them.
583aa5c2
RS
345
346=back
347
348=head1 Selected Bug Fixes
349
350XXX Important bug fixes in the core language are summarized here. Bug fixes in
351files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
5ed58cbd 352
583aa5c2 353[ List each fix as a =item entry ]
32b79602 354
583aa5c2
RS
355=over 4
356
357=item *
358
c2a50ddb
NC
359The OP allocation code now returns correctly aligned memory in all cases
360for C<struct pmop>. Previously it could return memory only aligned to a
3614-byte boundary, which is not correct for an ithreads build with 64 bit IVs
362on some 32 bit platforms. Notably, this caused the build to fail completely
363on sparc GNU/Linux. [RT #118055]
583aa5c2 364
b019bbd2
NC
365=item *
366
367The debugger's C<man> command been fixed. It was broken in the v5.18.0
368release. The C<man> command is aliased to the names C<doc> and C<perldoc> -
369all now work again.
370
583aa5c2
RS
371=back
372
373=head1 Known Problems
374
375XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
376tests that had to be C<TODO>ed for the release would be noted here. Unfixed
377platform specific bugs also go here.
378
379[ List each fix as a =item entry ]
380
381=over 4
382
383=item *
384
385XXX
386
387=back
388
389=head1 Obituary
390
391XXX If any significant core contributor has died, we've added a short obituary
392here.
393
394=head1 Acknowledgements
a75569c0 395
583aa5c2 396XXX Generate this with:
e9912eaa 397
583aa5c2 398 perl Porting/acknowledgements.pl v5.19.1..HEAD
f5b73711 399
44691e6f
AB
400=head1 Reporting Bugs
401
e08634c5
SH
402If you find what you think is a bug, you might check the articles recently
403posted to the comp.lang.perl.misc newsgroup and the perl bug database at
404http://rt.perl.org/perlbug/ . There may also be information at
405http://www.perl.org/ , the Perl Home Page.
44691e6f 406
e08634c5
SH
407If you believe you have an unreported bug, please run the L<perlbug> program
408included with your release. Be sure to trim your bug down to a tiny but
409sufficient test case. Your bug report, along with the output of C<perl -V>,
410will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f
AB
411
412If the bug you are reporting has security implications, which make it
e08634c5
SH
413inappropriate to send to a publicly archived mailing list, then please send it
414to perl5-security-report@perl.org. This points to a closed subscription
415unarchived mailing list, which includes all the core committers, who will be
416able to help assess the impact of issues, figure out a resolution, and help
f9001595 417co-ordinate the release of patches to mitigate or fix the problem across all
e08634c5
SH
418platforms on which Perl is supported. Please only use this address for
419security issues in the Perl core, not for modules independently distributed on
420CPAN.
44691e6f
AB
421
422=head1 SEE ALSO
423
e08634c5
SH
424The F<Changes> file for an explanation of how to view exhaustive details on
425what changed.
44691e6f
AB
426
427The F<INSTALL> file for how to build Perl.
428
429The F<README> file for general stuff.
430
431The F<Artistic> and F<Copying> files for copyright information.
432
433=cut