This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
e336889ec4b5f60e88f0d620eabf3ff53c3fa623
[perl5.git] / 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 XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.23.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.5 release and the 5.23.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.4, first read
16 L<perl5235delta>, which describes differences between 5.23.4 and 5.23.5.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head2 Using code points above the platform's C<IV_MAX> is now
82 deprecated
83
84 Unicode defines code points in the range C<0..0x10FFFF>.  Some standards
85 at one time defined them up to 2**31 - 1, but Perl has allowed them to
86 be as high as anything that will fit in a word on the platform being
87 used.  However, use of those above the platform's C<IV_MAX> is broken in
88 some constructs, notably C<tr///>, regular expression patterns involving
89 quantifiers, and in some arithmetic and comparison operations, such as
90 being the upper limit of a loop.  Now the use of such code points raises
91 a deprecation warning, unless that warning category is turned off.
92 C<IV_MAX> is typically 2**31 -1 on 32-bit platforms, and 2**63-1 on
93 64-bit ones.
94
95 =head1 Performance Enhancements
96
97 XXX Changes which enhance performance without changing behaviour go here.
98 There may well be none in a stable release.
99
100 [ List each enhancement as a =item entry ]
101
102 =over 4
103
104 =item *
105
106 XXX
107
108 =back
109
110 =head1 Modules and Pragmata
111
112 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
113 go here.  If Module::CoreList is updated, generate an initial draft of the
114 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
115 for important changes should then be added by hand.  In an ideal world,
116 dual-life modules would have a F<Changes> file that could be cribbed.
117
118 [ Within each section, list entries as a =item entry ]
119
120 =head2 New Modules and Pragmata
121
122 =over 4
123
124 =item *
125
126 XXX
127
128 =back
129
130 =head2 Updated Modules and Pragmata
131
132 =over 4
133
134 =item *
135
136 L<XXX> has been upgraded from version A.xx to B.yy.
137
138 =back
139
140 =head2 Removed Modules and Pragmata
141
142 =over 4
143
144 =item *
145
146 XXX
147
148 =back
149
150 =head1 Documentation
151
152 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
153 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
154
155 =head2 New Documentation
156
157 XXX Changes which create B<new> files in F<pod/> go here.
158
159 =head3 L<XXX>
160
161 XXX Description of the purpose of the new file here
162
163 =head2 Changes to Existing Documentation
164
165 XXX Changes which significantly change existing files in F<pod/> go here.
166 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
167 section.
168
169 =head3 L<XXX>
170
171 =over 4
172
173 =item *
174
175 XXX Description of the change here
176
177 =back
178
179 =head1 Diagnostics
180
181 The following additions or changes have been made to diagnostic output,
182 including warnings and fatal error messages.  For the complete list of
183 diagnostic messages, see L<perldiag>.
184
185 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
186 include any changes in L<perldiag> that reconcile it to the C<C> code.
187
188 =head2 New Diagnostics
189
190 XXX Newly added diagnostic messages go under here, separated into New Errors
191 and New Warnings
192
193 =head3 New Errors
194
195 =over 4
196
197 =item *
198
199 XXX L<message|perldiag/"message">
200
201 =back
202
203 =head3 New Warnings
204
205 =over 4
206
207 =item *
208
209 XXX L<message|perldiag/"message">
210
211 =back
212
213 =head2 Changes to Existing Diagnostics
214
215 XXX Changes (i.e. rewording) of diagnostic messages go here
216
217 =over 4
218
219 =item *
220
221 XXX Describe change here
222
223 =back
224
225 =head1 Utility Changes
226
227 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
228 Most of these are built within the directory F<utils>.
229
230 [ List utility changes as a =head2 entry for each utility and =item
231 entries for each change
232 Use L<XXX> with program names to get proper documentation linking. ]
233
234 =head2 L<XXX>
235
236 =over 4
237
238 =item *
239
240 XXX
241
242 =back
243
244 =head1 Configuration and Compilation
245
246 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
247 go here.  Any other changes to the Perl build process should be listed here.
248 However, any platform-specific changes should be listed in the
249 L</Platform Support> section, instead.
250
251 [ List changes as a =item entry ].
252
253 =over 4
254
255 =item *
256
257 XXX
258
259 =back
260
261 =head1 Testing
262
263 XXX Any significant changes to the testing of a freshly built perl should be
264 listed here.  Changes which create B<new> files in F<t/> go here as do any
265 large changes to the testing harness (e.g. when parallel testing was added).
266 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
267 that they represent may be covered elsewhere.
268
269 [ List each test improvement as a =item entry ]
270
271 =over 4
272
273 =item *
274
275 XXX
276
277 =back
278
279 =head1 Platform Support
280
281 XXX Any changes to platform support should be listed in the sections below.
282
283 [ Within the sections, list each platform as a =item entry with specific
284 changes as paragraphs below it. ]
285
286 =head2 New Platforms
287
288 XXX List any platforms that this version of perl compiles on, that previous
289 versions did not.  These will either be enabled by new files in the F<hints/>
290 directories, or new subdirectories and F<README> files at the top level of the
291 source tree.
292
293 =over 4
294
295 =item XXX-some-platform
296
297 XXX
298
299 =back
300
301 =head2 Discontinued Platforms
302
303 XXX List any platforms that this version of perl no longer compiles on.
304
305 =over 4
306
307 =item XXX-some-platform
308
309 XXX
310
311 =back
312
313 =head2 Platform-Specific Notes
314
315 XXX List any changes for specific platforms.  This could include configuration
316 and compilation changes or changes in portability/compatibility.  However,
317 changes within modules for platforms should generally be listed in the
318 L</Modules and Pragmata> section.
319
320 =over 4
321
322 =item EBCDIC platforms, such as z/OS
323
324 UTF-EBCDIC is like UTF-8, but for EBCDIC platforms.  It now has been
325 extended so that it can represent code points up to 2 ** 64 - 1 on
326 platforms with 64-bit words.  This brings it into parity with UTF-8.
327 This enhancement requires an incompatible change to the representation
328 of code points in the range 2 ** 30 to 2 ** 31 -1 (the latter was the
329 previous maximum representable code point).  This means that a file that
330 contains one of these code points, written out with previous versions of
331 perl cannot be read in, without conversion, by a perl containing this
332 change.  We do not believe any such files are in existence, but if you
333 do have one, submit a ticket at L<mailto:perlbug@perl.org>, and we will
334 write a conversion script for you.
335
336 =back
337
338 =head1 Internal Changes
339
340 XXX Changes which affect the interface available to C<XS> code go here.  Other
341 significant internal changes for future core maintainers should be noted as
342 well.
343
344 [ List each change as a =item entry ]
345
346 =over 4
347
348 =item *
349
350 XXX
351
352 =back
353
354 =head1 Selected Bug Fixes
355
356 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
357 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
358
359 [ List each fix as a =item entry ]
360
361 =over 4
362
363 =item *
364
365 XXX
366
367 =back
368
369 =head1 Known Problems
370
371 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
372 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
373 platform specific bugs also go here.
374
375 [ List each fix as a =item entry ]
376
377 =over 4
378
379 =item *
380
381 XXX
382
383 =back
384
385 =head1 Errata From Previous Releases
386
387 =over 4
388
389 =item *
390
391 XXX Add anything here that we forgot to add, or were mistaken about, in
392 the perldelta of a previous release.
393
394 =back
395
396 =head1 Obituary
397
398 XXX If any significant core contributor has died, we've added a short obituary
399 here.
400
401 =head1 Acknowledgements
402
403 XXX Generate this with:
404
405   perl Porting/acknowledgements.pl v5.23.5..HEAD
406
407 =head1 Reporting Bugs
408
409 If you find what you think is a bug, you might check the articles recently
410 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
411 L<https://rt.perl.org/> .  There may also be information at
412 L<http://www.perl.org/> , the Perl Home Page.
413
414 If you believe you have an unreported bug, please run the L<perlbug> program
415 included with your release.  Be sure to trim your bug down to a tiny but
416 sufficient test case.  Your bug report, along with the output of C<perl -V>,
417 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
418
419 If the bug you are reporting has security implications, which make it
420 inappropriate to send to a publicly archived mailing list, then please send it
421 to perl5-security-report@perl.org.  This points to a closed subscription
422 unarchived mailing list, which includes all the core committers, who will be
423 able to help assess the impact of issues, figure out a resolution, and help
424 co-ordinate the release of patches to mitigate or fix the problem across all
425 platforms on which Perl is supported.  Please only use this address for
426 security issues in the Perl core, not for modules independently distributed on
427 CPAN.
428
429 =head1 SEE ALSO
430
431 The F<Changes> file for an explanation of how to view exhaustive details on
432 what changed.
433
434 The F<INSTALL> file for how to build Perl.
435
436 The F<README> file for general stuff.
437
438 The F<Artistic> and F<Copying> files for copyright information.
439
440 =cut