Upgrade Filter-Util-Call from version 1.54 to 1.55
[perl.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.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.1 release and the 5.23.2
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.0, first read
16 L<perl5231delta>, which describes differences between 5.23.0 and 5.23.1.
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 =head1 Performance Enhancements
82
83 XXX Changes which enhance performance without changing behaviour go here.
84 There may well be none in a stable release.
85
86 [ List each enhancement as a =item entry ]
87
88 =over 4
89
90 =item *
91
92 XXX
93
94 =back
95
96 =head1 Modules and Pragmata
97
98 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
99 go here.  If Module::CoreList is updated, generate an initial draft of the
100 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
101 for important changes should then be added by hand.  In an ideal world,
102 dual-life modules would have a F<Changes> file that could be cribbed.
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
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<Encode> has been upgraded from version 2.75 to 2.76.
123
124 =item *
125
126 L<Filter::Util::Call> has been upgraded from version 1.54 to 1.55.
127
128 =item *
129
130 The PathTools module collection has been upgraded from version 3.55 to
131 3.56.
132
133 Minor optimizations. [perl #125712]
134
135 =back
136
137 =head2 Removed Modules and Pragmata
138
139 =over 4
140
141 =item *
142
143 XXX
144
145 =back
146
147 =head1 Documentation
148
149 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
150 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
151
152 =head2 New Documentation
153
154 XXX Changes which create B<new> files in F<pod/> go here.
155
156 =head3 L<XXX>
157
158 XXX Description of the purpose of the new file here
159
160 =head2 Changes to Existing Documentation
161
162 XXX Changes which significantly change existing files in F<pod/> go here.
163 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
164 section.
165
166 =head3 L<XXX>
167
168 =over 4
169
170 =item *
171
172 XXX Description of the change here
173
174 =back
175
176 =head1 Diagnostics
177
178 The following additions or changes have been made to diagnostic output,
179 including warnings and fatal error messages.  For the complete list of
180 diagnostic messages, see L<perldiag>.
181
182 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
183 include any changes in L<perldiag> that reconcile it to the C<C> code.
184
185 =head2 New Diagnostics
186
187 XXX Newly added diagnostic messages go under here, separated into New Errors
188 and New Warnings
189
190 =head3 New Errors
191
192 =over 4
193
194 =item *
195
196 XXX L<message|perldiag/"message">
197
198 =back
199
200 =head3 New Warnings
201
202 =over 4
203
204 =item *
205
206 XXX L<message|perldiag/"message">
207
208 =back
209
210 =head2 Changes to Existing Diagnostics
211
212 XXX Changes (i.e. rewording) of diagnostic messages go here
213
214 =over 4
215
216 =item *
217
218 XXX Describe change here
219
220 =back
221
222 =head1 Utility Changes
223
224 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
225 Most of these are built within the directory F<utils>.
226
227 [ List utility changes as a =head2 entry for each utility and =item
228 entries for each change
229 Use L<XXX> with program names to get proper documentation linking. ]
230
231 =head2 L<XXX>
232
233 =over 4
234
235 =item *
236
237 XXX
238
239 =back
240
241 =head1 Configuration and Compilation
242
243 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
244 go here.  Any other changes to the Perl build process should be listed here.
245 However, any platform-specific changes should be listed in the
246 L</Platform Support> section, instead.
247
248 [ List changes as a =item entry ].
249
250 =over 4
251
252 =item *
253
254 XXX
255
256 =back
257
258 =head1 Testing
259
260 XXX Any significant changes to the testing of a freshly built perl should be
261 listed here.  Changes which create B<new> files in F<t/> go here as do any
262 large changes to the testing harness (e.g. when parallel testing was added).
263 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
264 that they represent may be covered elsewhere.
265
266 [ List each test improvement as a =item entry ]
267
268 =over 4
269
270 =item *
271
272 XXX
273
274 =back
275
276 =head1 Platform Support
277
278 XXX Any changes to platform support should be listed in the sections below.
279
280 [ Within the sections, list each platform as a =item entry with specific
281 changes as paragraphs below it. ]
282
283 =head2 New Platforms
284
285 XXX List any platforms that this version of perl compiles on, that previous
286 versions did not.  These will either be enabled by new files in the F<hints/>
287 directories, or new subdirectories and F<README> files at the top level of the
288 source tree.
289
290 =over 4
291
292 =item XXX-some-platform
293
294 XXX
295
296 =back
297
298 =head2 Discontinued Platforms
299
300 XXX List any platforms that this version of perl no longer compiles on.
301
302 =over 4
303
304 =item XXX-some-platform
305
306 XXX
307
308 =back
309
310 =head2 Platform-Specific Notes
311
312 XXX List any changes for specific platforms.  This could include configuration
313 and compilation changes or changes in portability/compatibility.  However,
314 changes within modules for platforms should generally be listed in the
315 L</Modules and Pragmata> section.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head1 Internal Changes
326
327 XXX Changes which affect the interface available to C<XS> code go here.  Other
328 significant internal changes for future core maintainers should be noted as
329 well.
330
331 [ List each change as a =item entry ]
332
333 =over 4
334
335 =item *
336
337 XXX
338
339 =back
340
341 =head1 Selected Bug Fixes
342
343 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
344 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
345
346 [ List each fix as a =item entry ]
347
348 =over 4
349
350 =item *
351
352 Perl can again be compiled with any Unicode version.  This used to
353 (mostly) work, but was lost in v5.18 through v5.20.  The property
354 C<Name_Alias> did not exist prior to Unicode 5.0.  L<Unicode::UCD>
355 incorrectly said it did.  This has been fixed.
356
357 =back
358
359 =head1 Known Problems
360
361 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
362 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
363 platform specific bugs also go here.
364
365 [ List each fix as a =item entry ]
366
367 =over 4
368
369 =item *
370
371 XXX
372
373 =back
374
375 =head1 Errata From Previous Releases
376
377 =over 4
378
379 =item *
380
381 XXX Add anything here that we forgot to add, or were mistaken about, in
382 the perldelta of a previous release.
383
384 =back
385
386 =head1 Obituary
387
388 XXX If any significant core contributor has died, we've added a short obituary
389 here.
390
391 =head1 Acknowledgements
392
393 XXX Generate this with:
394
395   perl Porting/acknowledgements.pl v5.23.1..HEAD
396
397 =head1 Reporting Bugs
398
399 If you find what you think is a bug, you might check the articles recently
400 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
401 L<https://rt.perl.org/> .  There may also be information at
402 L<http://www.perl.org/> , the Perl Home Page.
403
404 If you believe you have an unreported bug, please run the L<perlbug> program
405 included with your release.  Be sure to trim your bug down to a tiny but
406 sufficient test case.  Your bug report, along with the output of C<perl -V>,
407 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
408
409 If the bug you are reporting has security implications, which make it
410 inappropriate to send to a publicly archived mailing list, then please send it
411 to perl5-security-report@perl.org.  This points to a closed subscription
412 unarchived mailing list, which includes all the core committers, who will be
413 able to help assess the impact of issues, figure out a resolution, and help
414 co-ordinate the release of patches to mitigate or fix the problem across all
415 platforms on which Perl is supported.  Please only use this address for
416 security issues in the Perl core, not for modules independently distributed on
417 CPAN.
418
419 =head1 SEE ALSO
420
421 The F<Changes> file for an explanation of how to view exhaustive details on
422 what changed.
423
424 The F<INSTALL> file for how to build Perl.
425
426 The F<README> file for general stuff.
427
428 The F<Artistic> and F<Copying> files for copyright information.
429
430 =cut