This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
toke.c: Fix comment
[perl5.git] / pod / perldelta.pod
CommitLineData
44691e6f
AB
1=encoding utf8
2
3=head1 NAME
4
0302547a 5perldelta - what is new for perl v5.25.1
eabfc7bc 6
2cfe9b50 7=head1 DESCRIPTION
eabfc7bc 8
0302547a 9This document describes differences between the 5.25.0 release and the 5.25.1
4b8803f0 10release.
f3ed8cbf 11
0302547a
RS
12If you are upgrading from an earlier release such as 5.24.0, first read
13L<perl5250delta>, which describes differences between 5.24.0 and 5.25.0.
eabfc7bc 14
0302547a 15=head1 Notice
fac0c351 16
0302547a
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
61463a3e 37=head2 C<NBSP> is no longer permissible in C<\N{...}>
0302547a 38
61463a3e
KW
39The name of a character may no longer contain non-breaking spaces. It
40has been deprecated to do so since Perl v5.22.
0302547a
RS
41
42=head1 Deprecations
43
44XXX Any deprecated features, syntax, modules etc. should be listed here.
45
46=head2 Module removals
47
48XXX Remove this section if inapplicable.
49
50The following modules will be removed from the core distribution in a
51future release, and will at that time need to be installed from CPAN.
52Distributions on CPAN which require these modules will need to list them as
53prerequisites.
54
55The core versions of these modules will now issue C<"deprecated">-category
56warnings to alert you to this fact. To silence these deprecation warnings,
57install the modules in question from CPAN.
58
59Note that these are (with rare exceptions) fine modules that you are encouraged
60to continue to use. Their disinclusion from core primarily hinges on their
61necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
62not usually on concerns over their design.
63
64=over
65
66=item XXX
67
68XXX Note that deprecated modules should be listed here even if they are listed
69as an updated module in the L</Modules and Pragmata> section.
70
71=back
72
73[ List each other deprecation as a =head2 entry ]
74
75=head1 Performance Enhancements
76
77XXX Changes which enhance performance without changing behaviour go here.
78There may well be none in a stable release.
79
80[ List each enhancement as a =item entry ]
81
82=over 4
83
84=item *
85
86XXX
87
88=back
89
90=head1 Modules and Pragmata
91
92XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
93go here. If Module::CoreList is updated, generate an initial draft of the
94following sections using F<Porting/corelist-perldelta.pl>. A paragraph summary
95for important changes should then be added by hand. In an ideal world,
96dual-life modules would have a F<Changes> file that could be cribbed.
97
98[ Within each section, list entries as a =item entry ]
99
100=head2 New Modules and Pragmata
101
102=over 4
103
104=item *
105
106XXX
107
108=back
109
110=head2 Updated Modules and Pragmata
111
112=over 4
113
114=item *
115
116L<XXX> has been upgraded from version A.xx to B.yy.
117
118=back
119
120=head2 Removed Modules and Pragmata
121
122=over 4
123
124=item *
125
126XXX
127
128=back
129
130=head1 Documentation
131
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>.
134
135=head2 New Documentation
136
137XXX Changes which create B<new> files in F<pod/> go here.
138
139=head3 L<XXX>
140
141XXX Description of the purpose of the new file here
142
143=head2 Changes to Existing Documentation
144
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.
148
149=head3 L<XXX>
150
151=over 4
152
153=item *
154
155XXX Description of the change here
156
157=back
158
159=head1 Diagnostics
160
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>.
164
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.
167
168=head2 New Diagnostics
169
170XXX Newly added diagnostic messages go under here, separated into New Errors
171and New Warnings
172
173=head3 New Errors
174
175=over 4
176
177=item *
178
179XXX L<message|perldiag/"message">
180
181=back
182
183=head3 New Warnings
184
185=over 4
186
187=item *
188
189XXX L<message|perldiag/"message">
190
191=back
e1ad135d 192
0302547a 193=head2 Changes to Existing Diagnostics
be2c0c65 194
0302547a 195XXX Changes (i.e. rewording) of diagnostic messages go here
be2c0c65 196
0302547a
RS
197=over 4
198
199=item *
200
201XXX Describe change here
202
203=back
204
205=head1 Utility Changes
206
207XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
208Most of these are built within the directory F<utils>.
209
210[ List utility changes as a =head2 entry for each utility and =item
211entries for each change
212Use L<XXX> with program names to get proper documentation linking. ]
213
214=head2 L<XXX>
215
216=over 4
217
218=item *
219
220XXX
221
222=back
223
224=head1 Configuration and Compilation
225
226XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
227go here. Any other changes to the Perl build process should be listed here.
228However, any platform-specific changes should be listed in the
229L</Platform Support> section, instead.
230
231[ List changes as a =item entry ].
232
233=over 4
234
235=item *
236
237XXX
238
239=back
240
241=head1 Testing
242
243XXX Any significant changes to the testing of a freshly built perl should be
244listed here. Changes which create B<new> files in F<t/> go here as do any
245large changes to the testing harness (e.g. when parallel testing was added).
246Changes to existing files in F<t/> aren't worth summarizing, although the bugs
247that they represent may be covered elsewhere.
248
249[ List each test improvement as a =item entry ]
250
251=over 4
252
253=item *
254
255XXX
256
257=back
258
259=head1 Platform Support
260
261XXX Any changes to platform support should be listed in the sections below.
262
263[ Within the sections, list each platform as a =item entry with specific
264changes as paragraphs below it. ]
265
266=head2 New Platforms
267
268XXX List any platforms that this version of perl compiles on, that previous
269versions did not. These will either be enabled by new files in the F<hints/>
270directories, or new subdirectories and F<README> files at the top level of the
271source tree.
272
273=over 4
274
275=item XXX-some-platform
276
277XXX
278
279=back
280
281=head2 Discontinued Platforms
282
283XXX List any platforms that this version of perl no longer compiles on.
284
285=over 4
286
287=item XXX-some-platform
288
289XXX
290
291=back
292
293=head2 Platform-Specific Notes
294
295XXX List any changes for specific platforms. This could include configuration
296and compilation changes or changes in portability/compatibility. However,
297changes within modules for platforms should generally be listed in the
298L</Modules and Pragmata> section.
299
300=over 4
301
302=item XXX-some-platform
303
304XXX
305
306=back
307
308=head1 Internal Changes
309
310XXX Changes which affect the interface available to C<XS> code go here. Other
311significant internal changes for future core maintainers should be noted as
312well.
313
314[ List each change as a =item entry ]
315
316=over 4
317
318=item *
319
320XXX
321
322=back
323
324=head1 Selected Bug Fixes
325
326XXX Important bug fixes in the core language are summarized here. Bug fixes in
327files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
328
329[ List each fix as a =item entry ]
330
331=over 4
332
333=item *
334
335XXX
336
337=back
338
339=head1 Known Problems
340
341XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
342tests that had to be C<TODO>ed for the release would be noted here. Unfixed
343platform specific bugs also go here.
344
345[ List each fix as a =item entry ]
346
347=over 4
348
349=item *
350
351XXX
352
353=back
354
355=head1 Errata From Previous Releases
356
357=over 4
358
359=item *
360
361XXX Add anything here that we forgot to add, or were mistaken about, in
362the perldelta of a previous release.
363
364=back
365
366=head1 Obituary
367
368XXX If any significant core contributor has died, we've added a short obituary
369here.
370
371=head1 Acknowledgements
be2c0c65 372
0302547a 373Generate this with:
be2c0c65 374
0302547a 375 perl Porting/acknowledgements.pl v5.25.1..HEAD
f5b73711 376
44691e6f
AB
377=head1 Reporting Bugs
378
e08634c5
SH
379If you find what you think is a bug, you might check the articles recently
380posted to the comp.lang.perl.misc newsgroup and the perl bug database at
4b8803f0
RS
381L<https://rt.perl.org/> . There may also be information at
382L<http://www.perl.org/> , the Perl Home Page.
44691e6f 383
e08634c5
SH
384If you believe you have an unreported bug, please run the L<perlbug> program
385included with your release. Be sure to trim your bug down to a tiny but
386sufficient test case. Your bug report, along with the output of C<perl -V>,
387will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
44691e6f 388
87c118b9
DM
389If the bug you are reporting has security implications which make it
390inappropriate to send to a publicly archived mailing list, then see
391L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
392for details of how to report the issue.
44691e6f
AB
393
394=head1 SEE ALSO
395
e08634c5
SH
396The F<Changes> file for an explanation of how to view exhaustive details on
397what changed.
44691e6f
AB
398
399The F<INSTALL> file for how to build Perl.
400
401The F<README> file for general stuff.
402
403The F<Artistic> and F<Copying> files for copyright information.
404
405=cut