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